Mercurial > emacs
annotate lispref/display.texi @ 79750:a1e16e813aed
Add 2008 to copyright years.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Mon, 07 Jan 2008 08:49:10 +0000 |
parents | f5b1ac20303d |
children |
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, |
79750 | 4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 | |
79484
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
58 In Emacs, processing user input takes priority over redisplay. If |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
59 you call these functions when input is available, they don't redisplay |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
60 immediately, but the requested redisplay does happen |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
61 eventually---after all the input has been processed. |
12098 | 62 |
6598 | 63 Normally, suspending and resuming Emacs also refreshes the screen. |
64 Some terminal emulators record separate contents for display-oriented | |
65 programs such as Emacs and for ordinary sequential display. If you are | |
66 using such a terminal, you might want to inhibit the redisplay on | |
9009 | 67 resumption. |
6598 | 68 |
69 @defvar no-redraw-on-reenter | |
70 @cindex suspend (cf. @code{no-redraw-on-reenter}) | |
71 @cindex resume (cf. @code{no-redraw-on-reenter}) | |
72 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
|
73 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
|
74 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. |
6598 | 75 @end defvar |
76 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
77 @node Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
78 @section Forcing Redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
79 @cindex forcing redisplay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
80 |
79484
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
81 Emacs normally tries to redisplay the screen whenever it waits for |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
82 input. With this function you can request an immediate attempt to |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
83 redisplay, in the middle of Lisp code, without actually waiting for |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
84 input. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
85 |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
86 @defun redisplay &optional force |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
87 This function tries immediately to redisplay, provided there are no |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
88 pending input events. It is equivalent to @code{(sit-for 0)}. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
89 |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
90 If the optional argument @var{force} is non-@code{nil}, it does all |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
91 pending redisplay work even if input is available, with no |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
92 pre-emption. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
93 |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
94 The function returns @code{t} if it actually tried to redisplay, and |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
95 @code{nil} otherwise. A value of @code{t} does not mean that |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
96 redisplay proceeded to completion; it could have been pre-empted by |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
97 newly arriving terminal input. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
98 @end defun |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
99 |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
100 @code{redisplay} with no argument tries immediately to redisplay, |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
101 but has no effect on the usual rules for what parts of the screen to |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
102 redisplay. By contrast, the following function adds certain windows |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
103 to the pending redisplay work (as if their contents had completely |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
104 changed), but doesn't immediately try to do any redisplay work. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
105 |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
106 @defun force-window-update &optional object |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
107 This function forces some or all windows to be updated on next |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
108 redisplay. If @var{object} is a window, it requires eventual |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
109 redisplay of that window. If @var{object} is a buffer or buffer name, |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
110 it requires eventual redisplay of all windows displaying that buffer. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
111 If @var{object} is @code{nil} (or omitted), it requires eventual |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
112 redisplay of all windows. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
113 @end defun |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
114 |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
115 @code{force-window-update} does not do a redisplay immediately. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
116 (Emacs will do that when it waits for input.) Rather, its effect is |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
117 to put more work on the queue to be done by redisplay whenever there |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
118 is a chance. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
119 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
120 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
|
121 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
|
122 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
|
123 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
|
124 |
79484
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
125 @defvar redisplay-dont-pause |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
126 If this variable is non-@code{nil}, pending input does not |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
127 prevent or halt redisplay; redisplay occurs, and finishes, |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
128 regardless of whether input is available. |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
129 @end defvar |
dbd4308fbdba
(Refresh Screen, Forcing Redisplay):
Richard M. Stallman <rms@gnu.org>
parents:
79010
diff
changeset
|
130 |
71325
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
131 @defvar redisplay-preemption-period |
71329
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
132 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
|
133 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
|
134 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
|
135 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
|
136 |
3e4b5e8df594
(Forcing Redisplay): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71328
diff
changeset
|
137 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
|
138 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
|
139 |
72058
92e52d7e4ecd
(Forcing Redisplay): Don't mention systems which
Kim F. Storm <storm@cua.dk>
parents:
72012
diff
changeset
|
140 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
|
141 text terminals, see @ref{Terminal Output}. |
71325
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
142 @end defvar |
ab800262f66c
(Forcing Redisplay): Add redisplay-preemption-period.
Kim F. Storm <storm@cua.dk>
parents:
71264
diff
changeset
|
143 |
6598 | 144 @node Truncation |
145 @section Truncation | |
146 @cindex line wrapping | |
76841 | 147 @cindex line truncation |
6598 | 148 @cindex continuation lines |
149 @cindex @samp{$} in display | |
150 @cindex @samp{\} in display | |
151 | |
71745
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
152 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
|
153 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
|
154 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
|
155 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
|
156 @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
|
157 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
|
158 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
|
159 boundary. @xref{Filling}. |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
160 |
5df595f18fa2
(Truncation): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
71730
diff
changeset
|
161 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
|
162 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
|
163 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
|
164 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
|
165 ``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
|
166 for this; @pxref{Display Tables}). |
6598 | 167 |
168 @defopt truncate-lines | |
169 This buffer-local variable controls how Emacs displays lines that extend | |
170 beyond the right edge of the window. The default is @code{nil}, which | |
171 specifies continuation. If the value is non-@code{nil}, then these | |
172 lines are truncated. | |
173 | |
174 If the variable @code{truncate-partial-width-windows} is non-@code{nil}, | |
175 then truncation is always used for side-by-side windows (within one | |
176 frame) regardless of the value of @code{truncate-lines}. | |
177 @end defopt | |
178 | |
12098 | 179 @defopt default-truncate-lines |
6598 | 180 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
|
181 buffers that do not have buffer-local values for it. |
12098 | 182 @end defopt |
6598 | 183 |
184 @defopt truncate-partial-width-windows | |
185 This variable controls display of lines that extend beyond the right | |
186 edge of the window, in side-by-side windows (@pxref{Splitting Windows}). | |
187 If it is non-@code{nil}, these lines are truncated; otherwise, | |
188 @code{truncate-lines} says what to do with them. | |
189 @end defopt | |
190 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
191 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
192 a window, that forces truncation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
193 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
194 If your buffer contains @emph{very} long lines, and you use |
12067 | 195 continuation to display them, just thinking about them can make Emacs |
12098 | 196 redisplay slow. The column computation and indentation functions also |
197 become slow. Then you might find it advisable to set | |
198 @code{cache-long-line-scans} to @code{t}. | |
12067 | 199 |
200 @defvar cache-long-line-scans | |
201 If this variable is non-@code{nil}, various indentation and motion | |
12098 | 202 functions, and Emacs redisplay, cache the results of scanning the |
203 buffer, and consult the cache to avoid rescanning regions of the buffer | |
204 unless they are modified. | |
12067 | 205 |
12098 | 206 Turning on the cache slows down processing of short lines somewhat. |
12067 | 207 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
208 This variable is automatically buffer-local in every buffer. |
12067 | 209 @end defvar |
210 | |
6598 | 211 @node The Echo Area |
212 @section The Echo Area | |
213 @cindex error display | |
214 @cindex echo area | |
215 | |
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
|
216 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
|
217 (@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
|
218 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
|
219 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
|
220 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
|
221 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
|
222 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
|
223 Minibuffer, emacs, The GNU Emacs Manual}). |
6598 | 224 |
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
|
225 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
|
226 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
|
227 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
|
228 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
229 @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
|
230 * 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
|
231 * 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
|
232 * 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
|
233 * 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
|
234 @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
|
235 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
236 @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
|
237 @subsection Displaying Messages in the Echo Area |
76841 | 238 @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
|
239 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
240 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
|
241 area messages. Many other Emacs features display messages there, too. |
6598 | 242 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
243 @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
|
244 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
|
245 @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
|
246 string. See @code{format} in @ref{Formatting Strings}, for the details |
6598 | 247 on the conversion specifications. @code{message} returns the |
248 constructed string. | |
249 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
250 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
|
251 error stream, followed by a newline. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
252 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
253 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
|
254 @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
|
255 |
6598 | 256 @c Emacs 19 feature |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
257 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
|
258 @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
|
259 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
|
260 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
|
261 onto the screen immediately. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
262 |
6598 | 263 @example |
264 @group | |
265 (message "Minibuffer depth is %d." | |
266 (minibuffer-depth)) | |
267 @print{} Minibuffer depth is 0. | |
268 @result{} "Minibuffer depth is 0." | |
269 @end group | |
270 | |
271 @group | |
272 ---------- Echo Area ---------- | |
273 Minibuffer depth is 0. | |
274 ---------- Echo Area ---------- | |
275 @end group | |
276 @end example | |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
277 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
278 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
|
279 depending on its size, use @code{display-message-or-buffer} (see below). |
6598 | 280 @end defun |
281 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
282 @defmac with-temp-message message &rest body |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
283 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
|
284 the execution of @var{body}. It displays @var{message}, executes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
285 @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
|
286 the previous echo area contents. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
287 @end defmac |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
288 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
289 @defun message-or-box format-string &rest arguments |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
290 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
|
291 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
|
292 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
|
293 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
294 @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
|
295 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
|
296 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
|
297 @ref{Yes-or-No Queries}.) |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
298 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
299 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
|
300 @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
|
301 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
302 |
65740
a0447a0dfab8
(Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents:
65598
diff
changeset
|
303 @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
|
304 @anchor{message-box} |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
305 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
|
306 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
|
307 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
|
308 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
|
309 @code{message}. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
310 @end defun |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22267
diff
changeset
|
311 |
32261
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
312 @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
|
313 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
|
314 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
|
315 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
|
316 in the echo area, using @code{message}. Otherwise, |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
317 @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
|
318 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
319 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
|
320 buffer is used, the window used to display it. |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
321 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
322 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
|
323 @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
|
324 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
|
325 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
|
326 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
|
327 |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
328 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
|
329 @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
|
330 @end defun |
c354d0540694
Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents:
32089
diff
changeset
|
331 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
332 @defun current-message |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
333 This function returns the message currently being displayed in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
334 echo area, or @code{nil} if there is none. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
335 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
336 |
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
|
337 @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
|
338 @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
|
339 @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
|
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 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
|
342 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
|
343 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
|
344 |
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 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
|
346 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
|
347 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
|
348 |
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 @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
|
350 (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
|
351 (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
|
352 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
|
353 (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
|
354 (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
|
355 (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
|
356 (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
|
357 @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
|
358 |
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 @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
|
360 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
|
361 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
|
362 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
|
363 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
|
364 |
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 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
|
366 @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
|
367 @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
|
368 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
|
369 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
|
370 |
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 @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
|
372 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
|
373 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
|
374 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
|
375 @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
|
376 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
|
377 @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
|
378 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
|
379 |
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 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
|
381 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
|
382 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
|
383 @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
|
384 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
|
385 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
|
386 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
|
387 @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
|
388 (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
|
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 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
|
391 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
|
392 @end defun |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
393 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
394 @defun progress-reporter-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
|
395 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
|
396 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
|
397 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
|
398 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
|
399 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
|
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 @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
|
402 @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
|
403 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
|
404 @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
|
405 @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
|
406 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
|
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 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
|
409 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
|
410 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
|
411 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
|
412 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
|
413 @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
|
414 |
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 @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
|
416 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
|
417 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
|
418 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
419 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
|
420 @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
|
421 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
|
422 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
|
423 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
|
424 @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
|
425 |
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 @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
|
427 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
|
428 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
|
429 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
|
430 |
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 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
|
432 @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
|
433 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
|
434 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
|
435 @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
|
436 |
66143 | 437 @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
|
438 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
|
439 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
|
440 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
|
441 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
442 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
|
443 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
|
444 |
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 @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
|
446 (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
|
447 (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
|
448 "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
|
449 (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
|
450 @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
|
451 @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
|
452 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
453 @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
|
454 @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
|
455 @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
|
456 |
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 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
|
458 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
|
459 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
|
460 @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
|
461 |
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 @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
|
463 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
|
464 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
|
465 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
|
466 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
|
467 |
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 @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
|
469 (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
|
470 (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
|
471 @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
|
472 @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
|
473 |
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 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
|
475 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
|
476 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
|
477 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
|
478 |
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 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
|
480 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
|
481 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
|
482 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
|
483 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
|
484 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
485 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
|
486 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
|
487 @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
|
488 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
|
489 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
|
490 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
491 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
|
492 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
|
493 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
|
494 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
|
495 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
496 @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
|
497 @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
|
498 |
8bd575c72fe0
(Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents:
63782
diff
changeset
|
499 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
|
500 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
501 @defvar cursor-in-echo-area |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
502 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
|
503 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
|
504 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
|
505 point---not in the echo area at all. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
506 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
507 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
|
508 for brief periods of time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
509 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
510 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
511 @defvar echo-area-clear-hook |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
512 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
|
513 @code{(message nil)} or for any other reason. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
514 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
515 |
12098 | 516 @defvar echo-keystrokes |
517 This variable determines how much time should elapse before command | |
27971 | 518 characters echo. Its value must be an integer or floating point number, |
519 which specifies the | |
12098 | 520 number of seconds to wait before echoing. If the user types a prefix |
521 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
|
522 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
|
523 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
|
524 sequence are echoed immediately.) |
12098 | 525 |
526 If the value is zero, then command input is not echoed. | |
527 @end defvar | |
528 | |
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
|
529 @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
|
530 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
|
531 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
|
532 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
|
533 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
|
534 @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
|
535 |
64841
c171f553d289
(Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents:
64411
diff
changeset
|
536 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
|
537 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
|
538 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
|
539 @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
|
540 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
541 @node Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
542 @section Reporting Warnings |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
543 @cindex warnings |
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 @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
|
546 possible problem, but continue running. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
547 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
548 @menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
549 * 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
|
550 * 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
|
551 * 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
|
552 @end menu |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
553 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
554 @node Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
555 @subsection Warning Basics |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
556 @cindex severity level |
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 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
|
559 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
|
560 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
|
561 meanings: |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
562 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
563 @table @code |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
564 @item :emergency |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
565 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
|
566 if you do not attend to it promptly. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
567 @item :error |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
568 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
|
569 @item :warning |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
570 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
|
571 raise suspicion of a possible problem. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
572 @item :debug |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
573 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
|
574 @end table |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
575 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
576 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
|
577 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
|
578 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
|
579 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
|
580 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
|
581 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
|
582 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
|
583 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
|
584 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
|
585 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
|
586 @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
|
587 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
|
588 |
52156
198af82c7606
(Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents:
52141
diff
changeset
|
589 @cindex warning type |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
590 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
|
591 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
|
592 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
|
593 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
|
594 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
|
595 list. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
596 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
597 @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
|
598 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
|
599 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
|
600 severity level, with @code{:warning} being the default. |
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 @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
|
603 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
|
604 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
605 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
606 @defun lwarn type level message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
607 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
|
608 @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
|
609 equivalent to @code{display-warning}. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
610 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
611 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
612 @defun warn message &rest args |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
613 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
|
614 @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
|
615 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
|
616 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
|
617 specify a specific warning type. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
618 @end defun |
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 @node Warning Variables |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
621 @subsection Warning Variables |
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 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
|
624 the variables described in this section. |
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-levels |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
627 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
|
628 severity levels. Each element defines one severity level, |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
629 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
|
630 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
631 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
|
632 @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
|
633 @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
|
634 @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
|
635 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
|
636 that information. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
637 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
638 The 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
|
639 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
|
640 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
641 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
|
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-prefix-function |
54023 | 645 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
|
646 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
|
647 @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
|
648 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
|
649 the beginning of the warning message. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
650 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
651 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
|
652 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
|
653 entry (this value need not be an actual member of |
54023 | 654 @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
|
655 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
|
656 a given severity level. |
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 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
|
659 to call. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
660 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
661 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
662 @defvar warning-series |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
663 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
|
664 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
|
665 that means to leave point on the first warning of the series, rather |
54023 | 666 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
|
667 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
|
668 @code{warning-series} becomes @code{nil} again. |
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 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
|
671 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
|
672 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
|
673 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
|
674 of warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
675 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
676 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
|
677 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
|
678 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
679 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
|
680 each warning separately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
681 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
682 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
683 @defvar warning-fill-prefix |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
684 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
|
685 use for filling each warning's text. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
686 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
687 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
688 @defvar warning-type-format |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
689 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
|
690 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
|
691 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
|
692 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
|
693 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
|
694 all. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
695 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
696 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
697 @node Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
698 @subsection Warning Options |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
699 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
700 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
|
701 when a Lisp program reports a warning. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
702 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
703 @defopt warning-minimum-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
704 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
|
705 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
|
706 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
|
707 warnings. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
708 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
709 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
710 @defopt warning-minimum-log-level |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
711 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
|
712 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
|
713 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
|
714 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
715 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
716 @defopt warning-suppress-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
717 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
|
718 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
|
719 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
|
720 type, then that warning is not displayed immediately. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
721 @end defopt |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
722 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
723 @defopt warning-suppress-log-types |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
724 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
|
725 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
|
726 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
|
727 that warning is not logged. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
728 @end defopt |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
729 |
12067 | 730 @node Invisible Text |
731 @section Invisible Text | |
732 | |
733 @cindex invisible text | |
734 You can make characters @dfn{invisible}, so that they do not appear on | |
735 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
|
736 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
|
737 (@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
|
738 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
|
739 point to the other side of them. |
12067 | 740 |
741 In the simplest case, any non-@code{nil} @code{invisible} property makes | |
742 a character invisible. This is the default case---if you don't alter | |
743 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
|
744 @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
|
745 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
|
746 to set @code{buffer-invisibility-spec} yourself. |
12067 | 747 |
748 More generally, you can use the variable @code{buffer-invisibility-spec} | |
749 to control which values of the @code{invisible} property make text | |
750 invisible. This permits you to classify the text into different subsets | |
751 in advance, by giving them different @code{invisible} values, and | |
752 subsequently make various subsets visible or invisible by changing the | |
753 value of @code{buffer-invisibility-spec}. | |
754 | |
755 Controlling visibility with @code{buffer-invisibility-spec} is | |
25875 | 756 especially useful in a program to display the list of entries in a |
757 database. It permits the implementation of convenient filtering | |
758 commands to view just a part of the entries in the database. Setting | |
759 this variable is very fast, much faster than scanning all the text in | |
760 the buffer looking for properties to change. | |
12067 | 761 |
762 @defvar buffer-invisibility-spec | |
763 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
|
764 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
|
765 buffer-local. |
12067 | 766 |
767 @table @asis | |
768 @item @code{t} | |
769 A character is invisible if its @code{invisible} property is | |
770 non-@code{nil}. This is the default. | |
771 | |
772 @item a list | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
773 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
|
774 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
|
775 the character is invisible. The list can have two kinds of elements: |
12067 | 776 |
777 @table @code | |
778 @item @var{atom} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
779 A character is invisible if its @code{invisible} property value |
12067 | 780 is @var{atom} or if it is a list with @var{atom} as a member. |
781 | |
782 @item (@var{atom} . t) | |
76850
21e50d7ec51d
(Invisible Text): Correct buffer-invisibility-spec regarding ellipsis.
Richard M. Stallman <rms@gnu.org>
parents:
76841
diff
changeset
|
783 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
|
784 @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
|
785 a sequence of such characters displays as an ellipsis. |
12067 | 786 @end table |
787 @end table | |
788 @end defvar | |
789 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
790 Two functions are specifically provided for adding elements to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
791 @code{buffer-invisibility-spec} and removing elements from it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
792 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
793 @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
|
794 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
|
795 @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
|
796 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
|
797 @code{invisible} property is @code{t} remains invisible. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
798 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
799 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
800 @defun remove-from-invisibility-spec element |
54023 | 801 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
|
802 @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
|
803 is not in the list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
804 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
805 |
48948
4dfb36c387bf
Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents:
48701
diff
changeset
|
806 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
|
807 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
|
808 @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
|
809 @code{invisible} property: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
810 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
811 @example |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
812 ;; @r{If you want to display an ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
813 (add-to-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
814 ;; @r{If you don't want ellipsis:} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
815 (add-to-invisibility-spec 'my-symbol) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
816 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
817 (overlay-put (make-overlay beginning end) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
818 'invisible 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
819 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
820 ;; @r{When done with the overlays:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
821 (remove-from-invisibility-spec '(my-symbol . t)) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
822 ;; @r{Or respectively:} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
823 (remove-from-invisibility-spec 'my-symbol) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
824 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
825 |
15761
77d451c08a30
Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
15074
diff
changeset
|
826 @vindex line-move-ignore-invisible |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
827 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
|
828 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
|
829 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
|
830 @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
|
831 only because they are explicitly programmed to do so. |
12098 | 832 |
69462
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
833 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
|
834 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
|
835 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
|
836 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
|
837 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
|
838 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
|
839 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
|
840 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
|
841 text. |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
842 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
843 Incremental search can make invisible overlays visible temporarily |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
844 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
|
845 this, the overlay should have a non-@code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
846 @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
|
847 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
|
848 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
|
849 overlaps the overlay on exit from the search. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
850 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
851 During the search, such overlays are made temporarily visible by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
852 temporarily modifying their invisible and intangible properties. If you |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
853 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
|
854 @code{isearch-open-invisible-temporary} property which is a function. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
855 The function is called with two arguments: the first is the overlay, and |
26986 | 856 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
|
857 make it invisible again. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
858 |
6598 | 859 @node Selective Display |
860 @section Selective Display | |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
861 @c @cindex selective display Duplicates selective-display |
6598 | 862 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
863 @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
|
864 hiding certain lines on the screen. |
6598 | 865 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
866 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
|
867 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
|
868 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
|
869 @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
|
870 features are different and do not work the same way. |
12067 | 871 |
872 In the second variant, the choice of lines to hide is made | |
12098 | 873 automatically based on indentation. This variant is designed to be a |
12067 | 874 user-level feature. |
6598 | 875 |
876 The way you control explicit selective display is by replacing a | |
9009 | 877 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
|
878 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
|
879 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
|
880 newlines can separate lines; it is now part of the previous line. |
6598 | 881 |
882 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
|
883 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
|
884 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
|
885 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
|
886 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
|
887 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
|
888 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
|
889 parts of the text are hidden. |
6598 | 890 |
891 When you write a selectively displayed buffer into a file, all the | |
892 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
|
893 in the file, it looks OK, with nothing hidden. The selective display |
6598 | 894 effect is seen only within Emacs. |
895 | |
896 @defvar selective-display | |
897 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
|
898 lines, or portions of lines, may be made hidden. |
6598 | 899 |
900 @itemize @bullet | |
901 @item | |
25875 | 902 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
|
903 control-m marks the start of hidden text; the control-m, and the rest |
25875 | 904 of the line following it, are not displayed. This is explicit selective |
905 display. | |
6598 | 906 |
907 @item | |
908 If the value of @code{selective-display} is a positive integer, then | |
909 lines that start with more than that many columns of indentation are not | |
910 displayed. | |
911 @end itemize | |
912 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
913 When some portion of a buffer is hidden, the vertical movement |
6598 | 914 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
|
915 @code{next-line} command to skip any number of hidden lines. |
6598 | 916 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
|
917 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
|
918 or delete text in an hidden portion. |
6598 | 919 |
920 In the examples below, we show the @emph{display appearance} of the | |
921 buffer @code{foo}, which changes with the value of | |
922 @code{selective-display}. The @emph{contents} of the buffer do not | |
923 change. | |
924 | |
925 @example | |
926 @group | |
927 (setq selective-display nil) | |
928 @result{} nil | |
929 | |
930 ---------- Buffer: foo ---------- | |
931 1 on this column | |
932 2on this column | |
933 3n this column | |
934 3n this column | |
935 2on this column | |
936 1 on this column | |
937 ---------- Buffer: foo ---------- | |
938 @end group | |
939 | |
940 @group | |
941 (setq selective-display 2) | |
942 @result{} 2 | |
943 | |
944 ---------- Buffer: foo ---------- | |
945 1 on this column | |
946 2on this column | |
947 2on this column | |
948 1 on this column | |
949 ---------- Buffer: foo ---------- | |
950 @end group | |
951 @end example | |
952 @end defvar | |
953 | |
954 @defvar selective-display-ellipses | |
955 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
|
956 @samp{@dots{}} at the end of a line that is followed by hidden text. |
6598 | 957 This example is a continuation of the previous one. |
958 | |
959 @example | |
960 @group | |
961 (setq selective-display-ellipses t) | |
962 @result{} t | |
963 | |
964 ---------- Buffer: foo ---------- | |
965 1 on this column | |
966 2on this column ... | |
967 2on this column | |
968 1 on this column | |
969 ---------- Buffer: foo ---------- | |
970 @end group | |
971 @end example | |
972 | |
973 You can use a display table to substitute other text for the ellipsis | |
974 (@samp{@dots{}}). @xref{Display Tables}. | |
975 @end defvar | |
976 | |
977 @node Temporary Displays | |
978 @section Temporary Displays | |
979 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
980 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
|
981 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
|
982 editing. Many help commands use this feature. |
6598 | 983 |
984 @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
|
985 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
|
986 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
|
987 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
|
988 displayed in some window, but not selected. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
989 |
52923
41c0ac1a4ed4
(Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52903
diff
changeset
|
990 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
|
991 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
|
992 @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
|
993 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
|
994 into clickable cross-references. @xref{Docstring hyperlinks, , Tips |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
995 for Documentation Strings}, in particular the item on hyperlinks in |
67874c814e45
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
996 documentation strings, for more details. |
6598 | 997 |
998 The string @var{buffer-name} specifies the temporary buffer, which | |
999 need not already exist. The argument must be a string, not a buffer. | |
1000 The buffer is erased initially (with no questions asked), and it is | |
1001 marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
1002 | |
1003 @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
1004 temporary buffer, then it evaluates the forms in @var{forms}. Output | |
1005 using the Lisp output functions within @var{forms} goes by default to | |
1006 that buffer (but screen display and messages in the echo area, although | |
1007 they are ``output'' in the general sense of the word, are not affected). | |
1008 @xref{Output Functions}. | |
1009 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1010 Several hooks are available for customizing the behavior |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1011 of this construct; they are listed below. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1012 |
6598 | 1013 The value of the last form in @var{forms} is returned. |
1014 | |
1015 @example | |
1016 @group | |
1017 ---------- Buffer: foo ---------- | |
1018 This is the contents of foo. | |
1019 ---------- Buffer: foo ---------- | |
1020 @end group | |
1021 | |
1022 @group | |
1023 (with-output-to-temp-buffer "foo" | |
1024 (print 20) | |
1025 (print standard-output)) | |
1026 @result{} #<buffer foo> | |
1027 | |
1028 ---------- Buffer: foo ---------- | |
1029 20 | |
1030 | |
1031 #<buffer foo> | |
1032 | |
1033 ---------- Buffer: foo ---------- | |
1034 @end group | |
1035 @end example | |
1036 @end defspec | |
1037 | |
1038 @defvar temp-buffer-show-function | |
9009 | 1039 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
6598 | 1040 calls it as a function to do the job of displaying a help buffer. The |
1041 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
|
1042 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1043 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
|
1044 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
|
1045 @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
|
1046 selected. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1047 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1048 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1049 @defvar temp-buffer-setup-hook |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1050 This normal hook is run by @code{with-output-to-temp-buffer} before |
42082 | 1051 evaluating @var{body}. When the hook runs, the temporary buffer is |
1052 current. This hook is normally set up with a function to put the | |
1053 buffer in Help mode. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1054 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
1055 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1056 @defvar temp-buffer-show-hook |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1057 This normal hook is run by @code{with-output-to-temp-buffer} after |
42082 | 1058 displaying the temporary buffer. When the hook runs, the temporary buffer |
1059 is current, and the window it was displayed in is selected. This hook | |
1060 is normally set up with a function to make the buffer read only, and | |
1061 find function names and variable names in it, provided the major mode | |
1062 is Help mode. | |
6598 | 1063 @end defvar |
1064 | |
1065 @defun momentary-string-display string position &optional char message | |
1066 This function momentarily displays @var{string} in the current buffer at | |
1067 @var{position}. It has no effect on the undo list or on the buffer's | |
1068 modification status. | |
1069 | |
1070 The momentary display remains until the next input event. If the next | |
1071 input event is @var{char}, @code{momentary-string-display} ignores it | |
1072 and returns. Otherwise, that event remains buffered for subsequent use | |
1073 as input. Thus, typing @var{char} will simply remove the string from | |
1074 the display, while typing (say) @kbd{C-f} will remove the string from | |
1075 the display and later (presumably) move point forward. The argument | |
1076 @var{char} is a space by default. | |
1077 | |
1078 The return value of @code{momentary-string-display} is not meaningful. | |
1079 | |
12098 | 1080 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
|
1081 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
|
1082 deleting) an overlay with a @code{before-string} property. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1083 @xref{Overlay Properties}. |
12098 | 1084 |
6598 | 1085 If @var{message} is non-@code{nil}, it is displayed in the echo area |
1086 while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
1087 default message says to type @var{char} to continue. | |
1088 | |
1089 In this example, point is initially located at the beginning of the | |
1090 second line: | |
1091 | |
1092 @example | |
1093 @group | |
1094 ---------- Buffer: foo ---------- | |
1095 This is the contents of foo. | |
1096 @point{}Second line. | |
1097 ---------- Buffer: foo ---------- | |
1098 @end group | |
1099 | |
1100 @group | |
1101 (momentary-string-display | |
1102 "**** Important Message! ****" | |
1103 (point) ?\r | |
1104 "Type RET when done reading") | |
1105 @result{} t | |
1106 @end group | |
1107 | |
1108 @group | |
1109 ---------- Buffer: foo ---------- | |
1110 This is the contents of foo. | |
1111 **** Important Message! ****Second line. | |
1112 ---------- Buffer: foo ---------- | |
1113 | |
1114 ---------- Echo Area ---------- | |
1115 Type RET when done reading | |
1116 ---------- Echo Area ---------- | |
1117 @end group | |
1118 @end example | |
1119 @end defun | |
1120 | |
1121 @node Overlays | |
1122 @section Overlays | |
1123 @cindex overlays | |
1124 | |
1125 You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
12098 | 1126 the screen, for the sake of presentation features. An overlay is an |
1127 object that belongs to a particular buffer, and has a specified | |
1128 beginning and end. It also has properties that you can examine and set; | |
1129 these affect the display of the text within the overlay. | |
6598 | 1130 |
68084 | 1131 An overlay uses markers to record its beginning and end; thus, |
54023 | 1132 editing the text of the buffer adjusts the beginning and end of each |
1133 overlay so that it stays with the text. When you create the overlay, | |
1134 you can specify whether text inserted at the beginning should be | |
1135 inside the overlay or outside, and likewise for the end of the overlay. | |
1136 | |
6598 | 1137 @menu |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1138 * 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
|
1139 * Overlay Properties:: How to read and set properties. |
6598 | 1140 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
|
1141 * Finding Overlays:: Searching for overlays. |
6598 | 1142 @end menu |
1143 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1144 @node Managing Overlays |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1145 @subsection Managing Overlays |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1146 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1147 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
|
1148 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
|
1149 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
|
1150 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
|
1151 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1152 @defun overlayp object |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1153 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
|
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 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
|
1157 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
|
1158 @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
|
1159 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
|
1160 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
|
1161 current buffer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1162 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1163 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
|
1164 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
|
1165 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
|
1166 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
|
1167 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
|
1168 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
|
1169 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
|
1170 @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
|
1171 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
|
1172 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1173 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1174 @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
|
1175 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
|
1176 as an integer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1177 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1178 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1179 @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
|
1180 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
|
1181 as an integer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1182 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1183 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1184 @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
|
1185 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
|
1186 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
|
1187 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1188 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1189 @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
|
1190 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
|
1191 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
|
1192 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
|
1193 display. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1194 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1195 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
|
1196 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
|
1197 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1198 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1199 @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
|
1200 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
|
1201 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
|
1202 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
|
1203 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1204 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
|
1205 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
|
1206 the current buffer. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1207 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1208 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
|
1209 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1210 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
|
1211 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
|
1212 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
|
1213 ``lost.'' |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1214 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1215 |
60782
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1216 @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
|
1217 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
|
1218 @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
|
1219 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
|
1220 |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1221 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
|
1222 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
|
1223 @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
|
1224 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
|
1225 current buffer. |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1226 @end defun |
ab5e3944cf27
(Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents:
60676
diff
changeset
|
1227 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1228 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
|
1229 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1230 @example |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1231 ;; @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
|
1232 (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
|
1233 @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
|
1234 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1235 @result{} 1 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1236 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1237 @result{} 10 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1238 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1239 @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
|
1240 ;; @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
|
1241 (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
|
1242 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1243 ;; @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
|
1244 (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
|
1245 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1246 ;; @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
|
1247 (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
|
1248 @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
|
1249 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1250 @result{} 5 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1251 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1252 @result{} 20 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1253 ;; @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
|
1254 (delete-overlay foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1255 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1256 ;; @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
|
1257 foo |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1258 @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
|
1259 ;; @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
|
1260 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1261 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1262 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1263 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1264 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1265 @result{} nil |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1266 ;; @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
|
1267 (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
|
1268 @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
|
1269 ;; @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
|
1270 (overlay-start foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1271 @result{} 1 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1272 (overlay-end foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1273 @result{} 20 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1274 (overlay-buffer foo) |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1275 @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
|
1276 ;; @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
|
1277 (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
|
1278 @result{} t |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1279 @end example |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1280 |
73780
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1281 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
|
1282 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
|
1283 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
|
1284 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
|
1285 in the buffer. |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1286 |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1287 @defun overlay-recenter pos |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1288 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
|
1289 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
|
1290 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
|
1291 @end defun |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1292 |
b84950e6ade6
(Managing Overlays): Document overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents:
72822
diff
changeset
|
1293 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
|
1294 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
|
1295 |
6598 | 1296 @node Overlay Properties |
1297 @subsection Overlay Properties | |
1298 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1299 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
|
1300 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
|
1301 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
|
1302 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1303 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
|
1304 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
|
1305 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
|
1306 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
|
1307 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
|
1308 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
|
1309 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
|
1310 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
|
1311 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1312 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
|
1313 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1314 @defun overlay-get overlay prop |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1315 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
|
1316 @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
|
1317 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
|
1318 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
|
1319 is @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1320 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1321 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1322 @defun overlay-put overlay prop value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1323 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
|
1324 @var{overlay} to @var{value}. It returns @var{value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1325 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1326 |
53422
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1327 @defun overlay-properties overlay |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1328 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
|
1329 @end defun |
1246d68686ac
(Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents:
53308
diff
changeset
|
1330 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1331 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
|
1332 overlay properties and text properties for a given character. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1333 @xref{Examining Properties}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1334 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1335 Many overlay properties have special meanings; here is a table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1336 of them: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1337 |
6598 | 1338 @table @code |
1339 @item priority | |
1340 @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
|
1341 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
|
1342 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
|
1343 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
|
1344 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
|
1345 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
|
1346 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
|
1347 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
|
1348 @code{face} property. |
6598 | 1349 |
1350 Currently, all overlays take priority over text properties. Please | |
1351 avoid using negative priority values, as we have not yet decided just | |
1352 what they should mean. | |
1353 | |
1354 @item window | |
1355 @kindex window @r{(overlay property)} | |
1356 If the @code{window} property is non-@code{nil}, then the overlay | |
1357 applies only on that window. | |
1358 | |
12067 | 1359 @item category |
1360 @kindex category @r{(overlay property)} | |
1361 If an overlay has a @code{category} property, we call it the | |
12098 | 1362 @dfn{category} of the overlay. It should be a symbol. The properties |
12067 | 1363 of the symbol serve as defaults for the properties of the overlay. |
1364 | |
6598 | 1365 @item face |
1366 @kindex face @r{(overlay property)} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1367 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
|
1368 font and which colors. @xref{Faces}, for more information. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1369 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1370 In the simplest case, the value is a face name. It can also be a list; |
25875 | 1371 then each element can be any of these possibilities: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1372 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1373 @itemize @bullet |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1374 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1375 A face name (a symbol or string). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1376 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1377 @item |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1378 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
|
1379 @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
|
1380 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
|
1381 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
|
1382 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
|
1383 Attributes}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1384 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1385 @item |
77123 | 1386 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
|
1387 @code{(background-color . @var{color-name})}. These elements specify |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1388 just the foreground color or just the background color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1389 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
1390 @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
|
1391 @code{(:foreground @var{color-name})}; likewise for the background. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1392 @end itemize |
6598 | 1393 |
1394 @item mouse-face | |
1395 @kindex mouse-face @r{(overlay property)} | |
1396 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
|
1397 the range of the overlay. |
6598 | 1398 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1399 @item display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1400 @kindex display @r{(overlay property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1401 This property activates various features that change the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1402 way text is displayed. For example, it can make text appear taller |
38278 | 1403 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
|
1404 @xref{Display Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1405 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1406 @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
|
1407 @kindex help-echo @r{(overlay property)} |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
1408 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
|
1409 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
|
1410 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
|
1411 help-echo}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1412 |
6598 | 1413 @item modification-hooks |
1414 @kindex modification-hooks @r{(overlay property)} | |
1415 This property's value is a list of functions to be called if any | |
1416 character within the overlay is changed or if text is inserted strictly | |
12067 | 1417 within the overlay. |
1418 | |
1419 The hook functions are called both before and after each change. | |
1420 If the functions save the information they receive, and compare notes | |
1421 between calls, they can determine exactly what change has been made | |
1422 in the buffer text. | |
1423 | |
1424 When called before a change, each function receives four arguments: the | |
1425 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
|
1426 modified. |
6598 | 1427 |
12067 | 1428 When called after a change, each function receives five arguments: the |
1429 overlay, @code{t}, the beginning and end of the text range just | |
1430 modified, and the length of the pre-change text replaced by that range. | |
1431 (For an insertion, the pre-change length is zero; for a deletion, that | |
1432 length is the number of characters deleted, and the post-change | |
12098 | 1433 beginning and end are equal.) |
12067 | 1434 |
64156
06f333c0aec7
(Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents:
63967
diff
changeset
|
1435 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
|
1436 @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
|
1437 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
|
1438 |
77542
170b9bea2267
(Overlay Properties): Add xref to Special Properties.
Richard M. Stallman <rms@gnu.org>
parents:
77360
diff
changeset
|
1439 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
|
1440 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
|
1441 |
6598 | 1442 @item insert-in-front-hooks |
1443 @kindex insert-in-front-hooks @r{(overlay property)} | |
12067 | 1444 This property's value is a list of functions to be called before and |
1445 after inserting text right at the beginning of the overlay. The calling | |
1446 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1447 |
1448 @item insert-behind-hooks | |
1449 @kindex insert-behind-hooks @r{(overlay property)} | |
12067 | 1450 This property's value is a list of functions to be called before and |
1451 after inserting text right at the end of the overlay. The calling | |
1452 conventions are the same as for the @code{modification-hooks} functions. | |
6598 | 1453 |
1454 @item invisible | |
1455 @kindex invisible @r{(overlay property)} | |
12067 | 1456 The @code{invisible} property can make the text in the overlay |
1457 invisible, which means that it does not appear on the screen. | |
1458 @xref{Invisible Text}, for details. | |
1459 | |
1460 @item intangible | |
1461 @kindex intangible @r{(overlay property)} | |
1462 The @code{intangible} property on an overlay works just like the | |
12098 | 1463 @code{intangible} text property. @xref{Special Properties}, for details. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1464 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1465 @item isearch-open-invisible |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1466 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
|
1467 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
|
1468 Text}. |
6598 | 1469 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1470 @item isearch-open-invisible-temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1471 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
|
1472 visible, temporarily, during the search. @xref{Invisible Text}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1473 |
6598 | 1474 @item before-string |
1475 @kindex before-string @r{(overlay property)} | |
1476 This property's value is a string to add to the display at the beginning | |
1477 of the overlay. The string does not appear in the buffer in any | |
25875 | 1478 sense---only on the screen. |
6598 | 1479 |
1480 @item after-string | |
1481 @kindex after-string @r{(overlay property)} | |
1482 This property's value is a string to add to the display at the end of | |
1483 the overlay. The string does not appear in the buffer in any | |
25875 | 1484 sense---only on the screen. |
12067 | 1485 |
1486 @item evaporate | |
1487 @kindex evaporate @r{(overlay property)} | |
1488 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
|
1489 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
|
1490 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
|
1491 it immediately. |
16123
ec5f48fe0320
Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
15761
diff
changeset
|
1492 |
29102 | 1493 @item local-map |
29076 | 1494 @cindex keymap of character (and overlays) |
29102 | 1495 @kindex local-map @r{(overlay property)} |
29076 | 1496 If this property is non-@code{nil}, it specifies a keymap for a portion |
1497 of the text. The property's value replaces the buffer's local map, when | |
1498 the character after point is within the overlay. @xref{Active Keymaps}. | |
33996 | 1499 |
1500 @item keymap | |
1501 @kindex keymap @r{(overlay property)} | |
1502 The @code{keymap} property is similar to @code{local-map} but overrides the | |
1503 buffer's local map (and the map specified by the @code{local-map} | |
1504 property) rather than replacing it. | |
29076 | 1505 @end table |
1506 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1507 @node Finding Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1508 @subsection Searching for Overlays |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1509 |
6598 | 1510 @defun overlays-at pos |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1511 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
|
1512 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
|
1513 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
|
1514 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
|
1515 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1516 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
|
1517 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
|
1518 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1519 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1520 (defun find-overlays-specifying (prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1521 (let ((overlays (overlays-at (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1522 found) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1523 (while overlays |
37170
29f2615d958f
(Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents:
36935
diff
changeset
|
1524 (let ((overlay (car overlays))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1525 (if (overlay-get overlay prop) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1526 (setq found (cons overlay found)))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1527 (setq overlays (cdr overlays))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1528 found)) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1529 @end smallexample |
6598 | 1530 @end defun |
1531 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1532 @defun overlays-in beg end |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1533 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
|
1534 @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
|
1535 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
|
1536 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
|
1537 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
|
1538 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1539 |
6598 | 1540 @defun next-overlay-change pos |
1541 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
|
1542 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
|
1543 @code{(point-max)}. |
6598 | 1544 @end defun |
1545 | |
12067 | 1546 @defun previous-overlay-change pos |
1547 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
|
1548 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
|
1549 @code{(point-min)}. |
12067 | 1550 @end defun |
1551 | |
76301
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1552 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
|
1553 primitive function @code{next-single-char-property-change} |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1554 (@pxref{Property Search}). It searches forward from position |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1555 @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
|
1556 @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
|
1557 changes. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1558 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1559 @smallexample |
76301
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1560 (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
|
1561 (save-excursion |
76301
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1562 (goto-char position) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1563 (let ((propval (get-char-property (point) prop))) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1564 (while (and (not (eobp)) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1565 (eq (get-char-property (point) prop) propval)) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1566 (goto-char (min (next-overlay-change (point)) |
fec7d780a786
(Finding Overlays): Write better example.
Richard M. Stallman <rms@gnu.org>
parents:
75875
diff
changeset
|
1567 (next-single-property-change (point) prop))))) |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1568 (point))) |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1569 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26400
diff
changeset
|
1570 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1571 @node Width |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1572 @section Width |
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 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
|
1575 check the width of a character. @xref{Primitive Indent}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1576 @ref{Screen Lines}, for related functions. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1577 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1578 @defun char-width char |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1579 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
|
1580 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
|
1581 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1582 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1583 @defun string-width string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1584 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
|
1585 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
|
1586 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1587 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1588 @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
|
1589 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
|
1590 @var{width} columns, as a new string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1591 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1592 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
|
1593 @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
|
1594 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
|
1595 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
|
1596 go beyond it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1597 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1598 The optional argument @var{start-column} specifies the starting column. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1599 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
|
1600 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
|
1601 @var{string} extends across the column @var{start-column}, that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1602 character is not included. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1603 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1604 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
|
1605 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
|
1606 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
|
1607 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
|
1608 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
|
1609 @var{string} extends across the column @var{start-column}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1610 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1611 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
|
1612 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
|
1613 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
|
1614 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
|
1615 @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
|
1616 @code{"..."}. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
1617 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1618 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1619 (truncate-string-to-width "\tab\t" 12 4) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1620 @result{} "ab" |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
1621 (truncate-string-to-width "\tab\t" 12 4 ?\s) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1622 @result{} " ab " |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1623 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1624 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
1625 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1626 @node Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1627 @section Line Height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1628 @cindex line height |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1629 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1630 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
|
1631 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
|
1632 above or below the display line. |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1633 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1634 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
|
1635 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
|
1636 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
|
1637 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
|
1638 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
|
1639 height of the default frame font.) |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1640 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1641 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
|
1642 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
|
1643 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
|
1644 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
|
1645 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1646 @kindex line-height @r{(text property)} |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1647 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
|
1648 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
|
1649 newline. |
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1650 |
71103
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1651 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
|
1652 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
|
1653 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
|
1654 (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
|
1655 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1656 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
|
1657 @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
|
1658 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
|
1659 @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
|
1660 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
|
1661 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
|
1662 |
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1663 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
|
1664 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
|
1665 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
|
1666 |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1667 @table @code |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1668 @item @var{integer} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1669 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
|
1670 @item @var{float} |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1671 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
|
1672 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
|
1673 @item (@var{face} . @var{ratio}) |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1674 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
|
1675 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
|
1676 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
|
1677 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
|
1678 @item (nil . @var{ratio}) |
59212
d928e34db52a
(Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents:
59137
diff
changeset
|
1679 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
|
1680 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
|
1681 @end table |
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1682 |
71103
4241daad4b09
(Line Height): Fix errors in description of
Richard M. Stallman <rms@gnu.org>
parents:
71009
diff
changeset
|
1683 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
|
1684 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
|
1685 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
|
1686 total height. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1687 |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
1688 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
|
1689 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
|
1690 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
|
1691 parts of Emacs text. |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1692 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1693 @vindex default-line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1694 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
|
1695 @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
|
1696 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
|
1697 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
|
1698 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
|
1699 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
|
1700 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
|
1701 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1702 @vindex line-spacing |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1703 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
|
1704 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
|
1705 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
|
1706 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
|
1707 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
|
1708 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1709 @kindex line-spacing @r{(text property)} |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
1710 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
|
1711 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
|
1712 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
|
1713 that newline. |
58902
e1ad27c7a13c
(Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents:
58883
diff
changeset
|
1714 |
59137
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1715 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
|
1716 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
|
1717 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
|
1718 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
|
1719 height. |
d7025bc399f1
(Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents:
58902
diff
changeset
|
1720 |
6598 | 1721 @node Faces |
1722 @section Faces | |
40469
aa8474236e9e
Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents:
40310
diff
changeset
|
1723 @cindex faces |
6598 | 1724 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1725 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
|
1726 family, foreground color, background color, optional underlining, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1727 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
|
1728 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
|
1729 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
|
1730 comes with. |
6598 | 1731 |
1732 @cindex face id | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1733 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
|
1734 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
|
1735 faces in Lisp programs by the symbols that name them. |
6598 | 1736 |
12067 | 1737 @defun facep object |
63777
fd183c9e3b18
(Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents:
63734
diff
changeset
|
1738 This function returns @code{t} if @var{object} is a face name string |
79683
f5b1ac20303d
(Faces): Don't talk about internal face vector as arg to facep.
Richard M. Stallman <rms@gnu.org>
parents:
79484
diff
changeset
|
1739 or symbol. It returns @code{nil} otherwise. |
12067 | 1740 @end defun |
1741 | |
6598 | 1742 Each face name is meaningful for all frames, and by default it has the |
1743 same meaning in all frames. But you can arrange to give a particular | |
1744 face name a special meaning in one frame if you wish. | |
1745 | |
1746 @menu | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1747 * 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
|
1748 * 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
|
1749 * 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
|
1750 * 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
|
1751 * 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
|
1752 * Face Functions:: How to define and examine faces. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1753 * Auto Faces:: Hook for automatic face assignment. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1754 * Font Lookup:: Looking up the names of available fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1755 and information about them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1756 * Fontsets:: A fontset is a collection of fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1757 that handle a range of character sets. |
6598 | 1758 @end menu |
1759 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1760 @node Defining Faces |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1761 @subsection Defining Faces |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1762 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1763 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
|
1764 kind of customization item (@pxref{Customization}) which the user can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1765 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
|
1766 emacs, The GNU Emacs Manual}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1767 |
66143 | 1768 @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
|
1769 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
|
1770 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
|
1771 and it should not end in @samp{-face} (that would be redundant). The |
25875 | 1772 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
|
1773 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
|
1774 @code{defcustom} (@pxref{Common Keywords}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1775 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1776 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
|
1777 @var{spec}, then uses any customizations that were read from the |
25875 | 1778 init file (@pxref{Init File}) to override that specification. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1779 |
78146
714a2d0b9062
(Defining Faces): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
78094
diff
changeset
|
1780 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
|
1781 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
|
1782 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
|
1783 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
|
1784 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1785 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
|
1786 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
|
1787 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
|
1788 @sc{car}, @var{display}, specifies a class of terminals. (The first |
68084 | 1789 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
|
1790 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
|
1791 @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
|
1792 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
|
1793 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
|
1794 @code{custom-face-attributes}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1795 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1796 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
|
1797 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
|
1798 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
|
1799 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
|
1800 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1801 @table @asis |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1802 @item @code{default} |
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1803 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
|
1804 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
|
1805 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
|
1806 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
|
1807 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1808 @item @code{t} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1809 This element of @var{spec} matches all frames. Therefore, any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1810 subsequent elements of @var{spec} are never used. Normally |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1811 @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
|
1812 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1813 @item a list |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1814 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
|
1815 @code{(@var{characteristic} @var{value}@dots{})}. Here |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1816 @var{characteristic} specifies a way of classifying frames, and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1817 @var{value}s are possible classifications which @var{display} should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1818 apply to. Here are the possible values of @var{characteristic}: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1819 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1820 @table @code |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1821 @item type |
32802
66f219c7e8ca
(Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents:
32552
diff
changeset
|
1822 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
|
1823 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
|
1824 @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
|
1825 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
|
1826 @xref{Window Systems, window-system}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1827 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1828 @item class |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1829 What kinds of colors the frame supports---either @code{color}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1830 @code{grayscale}, or @code{mono}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1831 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1832 @item background |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1833 The kind of background---either @code{light} or @code{dark}. |
45745 | 1834 |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1835 @item min-colors |
61854
60784460465e
(Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents:
60995
diff
changeset
|
1836 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
|
1837 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
|
1838 @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
|
1839 |
45745 | 1840 @item supports |
46170 | 1841 Whether or not the frame can display the face attributes given in |
1842 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation | |
1843 for the function @code{display-supports-face-attributes-p} for more | |
1844 information on exactly how this testing is done. @xref{Display Face | |
1845 Attribute Testing}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1846 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1847 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1848 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
|
1849 given @var{characteristic}, any of those values is acceptable. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1850 @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
|
1851 different @var{characteristic}; then @emph{each} characteristic of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1852 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
|
1853 @var{display}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1854 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1855 @end defmac |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1856 |
25875 | 1857 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
|
1858 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1859 @example |
25875 | 1860 @group |
77026
f9914fb8f8fa
(Defining Faces): Fix example.
Richard M. Stallman <rms@gnu.org>
parents:
77024
diff
changeset
|
1861 (defface region |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1862 '((((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
|
1863 :background "blue3") |
25875 | 1864 @end group |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1865 (((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
|
1866 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1867 (((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
|
1868 :background "blue3") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1869 (((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
|
1870 :background "lightgoldenrod2") |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1871 (((class color) (min-colors 8)) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1872 :background "blue" :foreground "white") |
25875 | 1873 (((type tty) (class mono)) |
54156
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1874 :inverse-video t) |
aa281cba47ea
(Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents:
54023
diff
changeset
|
1875 (t :background "gray")) |
25875 | 1876 @group |
1877 "Basic face for highlighting the region." | |
1878 :group 'basic-faces) | |
1879 @end group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1880 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1881 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1882 Internally, @code{defface} uses the symbol property |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1883 @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
|
1884 @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
|
1885 with the customization buffer, @code{customized-face} for the |
2b9aa367d2f8
(Defining Faces): Add `customized-face'.
Juri Linkov <juri@jurta.org>
parents:
63583
diff
changeset
|
1886 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
|
1887 saved, and @code{face-documentation} for the documentation string. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1888 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1889 @defopt frame-background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1890 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
|
1891 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
|
1892 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
|
1893 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
|
1894 as if they had a light background. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1895 @end defopt |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1896 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1897 @node Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1898 @subsection Face Attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1899 @cindex face attributes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1900 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1901 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
|
1902 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
|
1903 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
|
1904 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
|
1905 display the text. @xref{Displaying Faces}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1906 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
1907 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
|
1908 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
|
1909 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
|
1910 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
|
1911 specify all attributes. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1912 |
25875 | 1913 Some of these font attributes are meaningful only on certain kinds of |
1914 displays---if your display cannot handle a certain attribute, the | |
1915 attribute is ignored. (The attributes @code{:family}, @code{:width}, | |
1916 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of | |
1917 an X Logical Font Descriptor.) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1918 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1919 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1920 @item :family |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1921 Font family name, or fontset name (@pxref{Fontsets}). If you specify a |
25875 | 1922 font family name, the wild-card characters @samp{*} and @samp{?} are |
1923 allowed. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1924 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1925 @item :width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1926 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
|
1927 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
|
1928 @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1929 @code{normal}, @code{semi-expanded}, @code{expanded}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1930 @code{extra-expanded}, or @code{ultra-expanded}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1931 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1932 @item :height |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
1933 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
|
1934 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
|
1935 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
|
1936 (from the underlying face), and should return the new height. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1937 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1938 @item :weight |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1939 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
|
1940 @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
|
1941 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, |
25875 | 1942 or @code{ultra-light}. |
25809
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1943 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1944 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
|
1945 extra bright, and any weight less than normal is displayed as |
25875 | 1946 half-bright (provided the terminal supports the feature). |
1947 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1948 @item :slant |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1949 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
|
1950 @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
|
1951 |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1952 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
|
1953 the terminal supports the feature. |
89230444d638
patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents:
25751
diff
changeset
|
1954 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1955 @item :foreground |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1956 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
|
1957 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
|
1958 @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
|
1959 @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
|
1960 blue, and @samp{#ffffff} is white.) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
1961 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1962 @item :background |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
1963 Background color, a string, like the foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1964 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1965 @item :inverse-video |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1966 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
|
1967 value should be @code{t} (yes) or @code{nil} (no). |
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 @item :stipple |
25875 | 1970 The background stipple, a bitmap. |
1971 | |
1972 The value can be a string; that should be the name of a file containing | |
1973 external-format X bitmap data. The file is found in the directories | |
1974 listed in the variable @code{x-bitmap-file-path}. | |
1975 | |
40310
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39404
diff
changeset
|
1976 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
|
1977 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
|
1978 @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
|
1979 @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
|
1980 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
|
1981 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
|
1982 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
|
1983 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1984 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
|
1985 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1986 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
|
1987 used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1988 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1989 @item :underline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1990 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
|
1991 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
|
1992 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
|
1993 value @code{nil} means do not underline. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1994 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1995 @item :overline |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1996 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
|
1997 The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1998 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
1999 @item :strike-through |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2000 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
|
2001 color. The value is used like that of @code{:underline}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2002 |
32089
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
2003 @item :inherit |
15b8a53f1d7a
(Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents:
31373
diff
changeset
|
2004 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
|
2005 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
|
2006 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
|
2007 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
|
2008 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
|
2009 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2010 @item :box |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2011 Whether or not a box should be drawn around characters, its color, the |
25875 | 2012 width of the box lines, and 3D appearance. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2013 @end table |
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 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
|
2016 they mean: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2017 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2018 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2019 @item @code{nil} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2020 Don't draw a box. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2021 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2022 @item @code{t} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2023 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
|
2024 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2025 @item @var{color} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2026 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
|
2027 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2028 @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
|
2029 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
|
2030 @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
|
2031 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2032 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
|
2033 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
|
2034 color of the face for 3D boxes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2035 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2036 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
|
2037 @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
|
2038 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
|
2039 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
|
2040 is used. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2041 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2042 |
60442
747b9fc72d5e
(Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60218
diff
changeset
|
2043 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
|
2044 @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
|
2045 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
|
2046 semi-obsolete, but they still work: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2047 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2048 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2049 @item :font |
25875 | 2050 This attribute specifies the font name. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2051 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2052 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2053 A non-@code{nil} value specifies a bold font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2054 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2055 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2056 A non-@code{nil} value specifies an italic font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2057 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2058 |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
2059 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
|
2060 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
|
2061 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2062 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2063 @item :font |
25875 | 2064 You can specify an X font name as the ``value'' of this ``attribute''; |
2065 that sets the @code{:family}, @code{:width}, @code{:height}, | |
2066 @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
|
2067 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2068 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
|
2069 the pattern is used to set these attributes. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2070 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2071 @item :bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2072 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
|
2073 This actually works by setting the @code{:weight} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2074 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2075 @item :italic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2076 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
|
2077 This actually works by setting the @code{:slant} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2078 @end table |
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 @defvar x-bitmap-file-path |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2081 This variable specifies a list of directories for searching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2082 for bitmap files, for the @code{:stipple} attribute. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2083 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2084 |
25911
b192e4e3a9f5
Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents:
25875
diff
changeset
|
2085 @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
|
2086 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
|
2087 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
|
2088 @code{nil} otherwise. |
25875 | 2089 @end defun |
2090 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2091 @node Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2092 @subsection Face Attribute Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2093 |
72208
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2094 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
|
2095 attributes of an existing face. |
25751
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 @defun set-face-attribute face frame &rest arguments |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2098 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
|
2099 @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
|
2100 the @code{defface} says. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2101 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2102 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
|
2103 the values for them. They should consist of alternating attribute names |
25875 | 2104 (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
|
2105 Thus, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2106 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2107 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2108 (set-face-attribute 'foo nil |
46721
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2109 :width 'extended |
12862351ee03
Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents:
46338
diff
changeset
|
2110 :weight 'bold |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2111 :underline "red") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2112 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2113 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2114 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2115 sets the attributes @code{:width}, @code{:weight} and @code{:underline} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2116 to the corresponding values. |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2117 |
72208
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2118 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
|
2119 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
|
2120 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
|
2121 |
513c469ffd50
(Face Functions): Fix explanations of FRAME=t or nil.
Richard M. Stallman <rms@gnu.org>
parents:
72175
diff
changeset
|
2122 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
|
2123 all existing frames, and the default for new frames. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2124 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2125 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2126 @defun face-attribute face attribute &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2127 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
|
2128 @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
|
2129 that means the selected frame (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2130 |
72175
c9a89b23ca0f
(Face Attributes): Simplify wording.
Richard M. Stallman <rms@gnu.org>
parents:
72058
diff
changeset
|
2131 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
|
2132 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
|
2133 @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
|
2134 one, it returns @code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2135 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2136 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
|
2137 @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
|
2138 @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
|
2139 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
|
2140 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
|
2141 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
|
2142 @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
|
2143 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
|
2144 absolute. |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2145 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2146 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
|
2147 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
|
2148 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
|
2149 (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
|
2150 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2151 For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2152 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2153 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2154 (face-attribute 'bold :weight) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2155 @result{} bold |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2156 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2157 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2158 |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2159 @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
|
2160 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
|
2161 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
|
2162 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
|
2163 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
|
2164 another face. |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2165 |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2166 @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
|
2167 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
|
2168 |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2169 For example: |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2170 |
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2171 @example |
77360
467b5b7572bd
(Attribute Functions): Fix example for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
77123
diff
changeset
|
2172 (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
|
2173 @result{} t |
71643
e712aec3ce09
(Attribute Functions): Add examples for face-attribute-relative-p.
Richard M. Stallman <rms@gnu.org>
parents:
71638
diff
changeset
|
2174 @end example |
46240
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2175 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2176 |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2177 @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
|
2178 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
|
2179 @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
|
2180 @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
|
2181 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
|
2182 @end defun |
df64f9f41c5f
Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents:
46170
diff
changeset
|
2183 |
71730
cd88ff0d05f5
(Attribute Functions): Move paragraph about compatibility with Emacs < 21.
Richard M. Stallman <rms@gnu.org>
parents:
71719
diff
changeset
|
2184 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
|
2185 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
|
2186 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
|
2187 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
|
2188 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
|
2189 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2190 @defun set-face-foreground face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2191 @defunx set-face-background face color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2192 These functions set the foreground (or background, respectively) color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2193 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
|
2194 string, the name of a color. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2195 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2196 Certain shades of gray are implemented by stipple patterns on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2197 black-and-white screens. |
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-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
|
2201 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
|
2202 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
|
2203 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
|
2204 (@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
|
2205 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2206 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
|
2207 they are used automatically to handle certain shades of gray. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2208 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2209 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2210 @defun 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
|
2211 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
|
2212 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
|
2213 @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
|
2214 @var{font}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2215 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2216 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2217 @defun set-face-bold-p face bold-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2218 This function specifies whether @var{face} should be bold. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2219 @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
|
2220 This actually sets the @code{:weight} attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2221 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2222 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2223 @defun set-face-italic-p face italic-p &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2224 This function specifies whether @var{face} should be italic. If |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2225 @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
|
2226 This actually sets the @code{:slant} attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2227 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2228 |
75592
fa3660d23cc6
(Attribute Functions): Fix name and description of the UNDERLINE arg
Juanma Barranquero <lekktu@gmail.com>
parents:
75348
diff
changeset
|
2229 @defun set-face-underline-p face underline &optional frame |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2230 This function sets the underline attribute of face @var{face}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2231 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
|
2232 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
|
2233 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2234 |
65073
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2235 @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
|
2236 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
|
2237 @var{face}. |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2238 @end defun |
408e294257ab
(Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents:
64921
diff
changeset
|
2239 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2240 @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
|
2241 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
|
2242 @var{face}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2243 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2244 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2245 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
|
2246 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
|
2247 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
|
2248 @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
|
2249 attribute. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2250 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2251 @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
|
2252 @defunx face-background face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2253 These functions return the foreground color (or background color, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2254 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
|
2255 |
54777 | 2256 If @var{inherit} is @code{nil}, only a color directly defined by the face is |
2257 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
|
2258 @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
|
2259 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
|
2260 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
|
2261 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
|
2262 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2263 |
46245
fb42c0446cbf
Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents:
46240
diff
changeset
|
2264 @defun face-stipple face &optional frame inherit |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2265 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
|
2266 @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
|
2267 |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
2268 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
|
2269 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
|
2270 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
|
2271 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
|
2272 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
|
2273 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
|
2274 @var{inherit}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2275 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2276 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2277 @defun face-font face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2278 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
|
2279 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2280 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2281 @defun face-bold-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2282 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
|
2283 bolder than normal. It returns @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2284 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2285 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2286 @defun face-italic-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2287 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
|
2288 @code{nil} otherwise. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2289 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2290 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2291 @defun face-underline-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2292 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
|
2293 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2294 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2295 @defun face-inverse-video-p face &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2296 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
|
2297 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2298 |
59277
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2299 @node Displaying Faces |
120ce8e206a5
(Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents:
59212
diff
changeset
|
2300 @subsection Displaying Faces |
6598 | 2301 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2302 Here are the ways to specify which faces to use for display of text: |
6598 | 2303 |
2304 @itemize @bullet | |
2305 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2306 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
|
2307 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
|
2308 face is used only when no other face is specified.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2309 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2310 @item |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2311 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
|
2312 @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
|
2313 before @code{default}. |
6598 | 2314 |
2315 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2316 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
|
2317 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
|
2318 Properties}. |
6598 | 2319 |
2320 If the character has a @code{mouse-face} property, that is used instead | |
2321 of the @code{face} property when the mouse is ``near enough'' to the | |
2322 character. | |
2323 | |
2324 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2325 With overlays. An overlay can have @code{face} and @code{mouse-face} |
6598 | 2326 properties too; they apply to all the text covered by the overlay. |
2327 | |
2328 @item | |
12098 | 2329 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
|
2330 highlighted with the face @code{region} (@pxref{Standard Faces,,, |
88aad5396aac
(Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents:
65073
diff
changeset
|
2331 emacs, The GNU Emacs Manual}). |
12098 | 2332 |
2333 @item | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
2334 With special glyphs. Each glyph can specify a particular face |
6598 | 2335 number. @xref{Glyphs}. |
2336 @end itemize | |
2337 | |
2338 If these various sources together specify more than one face for a | |
2339 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
|
2340 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
|
2341 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
|
2342 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
|
2343 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
|
2344 @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
|
2345 line or a header line), and last the @code{default} face. |
6598 | 2346 |
2347 When multiple overlays cover one character, an overlay with higher | |
2348 priority overrides those with lower priority. @xref{Overlays}. | |
2349 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2350 @node Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2351 @subsection Font Selection |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2352 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2353 @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
|
2354 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
|
2355 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
|
2356 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
|
2357 it is. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2358 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2359 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
|
2360 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
|
2361 family, a font pattern is constructed. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2362 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2363 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
|
2364 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
|
2365 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
|
2366 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
|
2367 ``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
|
2368 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
|
2369 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
|
2370 try. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2371 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2372 @defvar face-font-selection-order |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2373 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
|
2374 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2375 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
|
2376 decreasing importance. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2377 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2378 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
|
2379 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
|
2380 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
|
2381 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2382 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
|
2383 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
|
2384 (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
|
2385 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
|
2386 non-normal faces contrast with normal ones, whenever possible. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2387 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2388 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
|
2389 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
|
2390 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
|
2391 and so on. |
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 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
|
2394 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
|
2395 @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
|
2396 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
|
2397 @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
|
2398 quite right. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2399 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2400 |
33373 | 2401 @defvar face-font-family-alternatives |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2402 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
|
2403 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
|
2404 this form: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2405 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2406 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2407 (@var{family} @var{alternate-families}@dots{}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2408 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2409 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2410 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
|
2411 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
|
2412 family that does exist. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2413 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2414 |
33373 | 2415 @defvar face-font-registry-alternatives |
2416 This variable lets you specify alternative font registries to try, if a | |
2417 given registry is specified and doesn't exist. Each element should have | |
2418 this form: | |
2419 | |
2420 @example | |
2421 (@var{registry} @var{alternate-registries}@dots{}) | |
2422 @end example | |
2423 | |
2424 If @var{registry} is specified but not available, Emacs will try the | |
2425 other registries given in @var{alternate-registries}, one by one, | |
2426 until it finds a registry that does exist. | |
2427 @end defvar | |
2428 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2429 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
|
2430 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
|
2431 XFree86 servers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2432 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2433 @defvar scalable-fonts-allowed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2434 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
|
2435 @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
|
2436 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
|
2437 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2438 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
|
2439 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
|
2440 expression in the list. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2441 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2442 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2443 (setq scalable-fonts-allowed '("muleindian-2$")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2444 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2445 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2446 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2447 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
|
2448 @end defvar |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2449 |
52002
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2450 @defvar face-font-rescale-alist |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2451 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
|
2452 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
|
2453 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2454 @example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2455 (@var{fontname-regexp} . @var{scale-factor}) |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2456 @end example |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2457 |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2458 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
|
2459 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
|
2460 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
|
2461 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
|
2462 nominal heights and widths would suggest. |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2463 @end defvar |
26d4153f70a1
(Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents:
51652
diff
changeset
|
2464 |
6598 | 2465 @node Face Functions |
2466 @subsection Functions for Working with Faces | |
2467 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2468 Here are additional functions for creating and working with faces. |
6598 | 2469 |
2470 @defun make-face name | |
2471 This function defines a new face named @var{name}, initially with all | |
2472 attributes @code{nil}. It does nothing if there is already a face named | |
2473 @var{name}. | |
2474 @end defun | |
2475 | |
2476 @defun face-list | |
2477 This function returns a list of all defined face names. | |
2478 @end defun | |
2479 | |
2480 @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
|
2481 This function defines a face named @var{new-name} as a copy of the existing |
6598 | 2482 face named @var{old-face}. It creates the face @var{new-name} if that |
2483 doesn't already exist. | |
2484 | |
2485 If the optional argument @var{frame} is given, this function applies | |
2486 only to that frame. Otherwise it applies to each frame individually, | |
2487 copying attributes from @var{old-face} in each frame to @var{new-face} | |
2488 in the same frame. | |
2489 | |
2490 If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2491 copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2492 in @var{new-frame}. | |
2493 @end defun | |
2494 | |
12098 | 2495 @defun face-id face |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2496 This function returns the face number of face @var{face}. |
6598 | 2497 @end defun |
2498 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2499 @defun face-documentation face |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2500 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
|
2501 @code{nil} if none was specified for it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2502 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
2503 |
6598 | 2504 @defun face-equal face1 face2 &optional frame |
2505 This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2506 same attributes for display. | |
2507 @end defun | |
2508 | |
2509 @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
|
2510 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
|
2511 differently from the default face. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2512 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2513 |
63659
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2514 @cindex face alias |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2515 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
|
2516 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
|
2517 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
|
2518 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
|
2519 |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2520 @example |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2521 (put 'modeline 'face-alias 'mode-line) |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2522 @end example |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2523 |
ce9e9d1055bf
(Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents:
63640
diff
changeset
|
2524 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2525 @node Auto Faces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2526 @subsection Automatic Face Assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2527 @cindex automatic face assignment |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2528 @cindex faces, automatic choice |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2529 |
78974
e9ee93a009f5
(Auto Faces): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents:
78938
diff
changeset
|
2530 This hook is used for automatically assigning faces to text in the |
77865
1616acf69fc8
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
77542
diff
changeset
|
2531 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
|
2532 Font-Lock. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2533 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2534 @defvar fontification-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2535 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
|
2536 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
|
2537 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2538 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
|
2539 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
|
2540 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
|
2541 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2542 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
|
2543 @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
|
2544 @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
|
2545 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
|
2546 already. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2547 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2548 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
|
2549 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
|
2550 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
|
2551 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
|
2552 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
|
2553 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2554 For efficiency, we recommend writing these functions so that they |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2555 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
|
2556 @end defvar |
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 @node Font Lookup |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2559 @subsection Looking Up Fonts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2560 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2561 @defun x-list-fonts pattern &optional face frame maximum |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2562 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
|
2563 @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
|
2564 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
|
2565 @var{face} currently is on @var{frame}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2566 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2567 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
|
2568 characters: the @samp{*} character matches any substring, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2569 @samp{?} character matches any single character. Pattern matching |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2570 of font names ignores case. |
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 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
|
2573 (a symbol) and @var{frame} should be a frame. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2574 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2575 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
|
2576 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
|
2577 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
|
2578 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
|
2579 many fonts match the pattern. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2580 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2581 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2582 @defun x-family-fonts &optional family frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2583 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
|
2584 @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
|
2585 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
|
2586 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
|
2587 contain the wildcards @samp{?} and @samp{*}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2588 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2589 The list 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
|
2590 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
|
2591 (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2592 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2593 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
|
2594 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2595 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2596 [@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
|
2597 @var{fixed-p} @var{full} @var{registry-and-encoding}] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2598 @end example |
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 first five elements correspond to face attributes; if you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2601 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
|
2602 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2603 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
|
2604 @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
|
2605 @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
|
2606 @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
|
2607 encoding of the font. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2608 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2609 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
|
2610 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2611 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2612 @defun x-font-family-list &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2613 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
|
2614 @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
|
2615 describes the selected frame's display (@pxref{Input Focus}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2616 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2617 The value is a list of elements of this form: |
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 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2620 (@var{family} . @var{fixed-p}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2621 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2622 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2623 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2624 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
|
2625 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
|
2626 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2627 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2628 @defvar font-list-limit |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2629 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
|
2630 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
|
2631 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
|
2632 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
|
2633 currently 100. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2634 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2635 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2636 @node Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2637 @subsection Fontsets |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2638 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2639 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
|
2640 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
|
2641 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
|
2642 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
|
2643 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
|
2644 information about defining a fontset under Lisp program control. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2645 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2646 @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
|
2647 This function defines a new fontset according to the specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2648 string @var{fontset-spec}. The string should have this format: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2649 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2650 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2651 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2652 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2653 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2654 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2655 Whitespace characters before and after the commas are ignored. |
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 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
|
2658 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
|
2659 @samp{fontset-@var{alias}}. |
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 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
|
2662 @var{fontpattern} in its entirety. The short name is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2663 @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
|
2664 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
|
2665 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
|
2666 function does nothing. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2667 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2668 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
|
2669 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
|
2670 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
|
2671 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
|
2672 status. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2673 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2674 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
|
2675 See below for the details. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2676 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2677 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2678 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
|
2679 use (in this fontset) for one particular character set. Here, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2680 @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
|
2681 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
|
2682 times in the specification string. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2683 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2684 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
|
2685 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
|
2686 @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
|
2687 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
|
2688 with @samp{ISO8859-1}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2689 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2690 In addition, when several consecutive fields are wildcards, Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2691 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
|
2692 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
|
2693 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
|
2694 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
|
2695 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2696 Thus if @var{fontpattern} is this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2697 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2698 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2699 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2700 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2701 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2702 @noindent |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52940
diff
changeset
|
2703 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
|
2704 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2705 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2706 -*-fixed-medium-r-normal-*-24-*-ISO8859-1 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2707 @end example |
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 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
|
2711 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2712 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2713 -*-fixed-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2714 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2715 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2716 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
|
2717 specification. Most X distributions include only Chinese fonts that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2718 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
|
2719 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
|
2720 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2721 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2722 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2723 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2724 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2725 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2726 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2727 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
|
2728 @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
|
2729 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
|
2730 field. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
2731 |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2732 @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
|
2733 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
|
2734 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
|
2735 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2736 If @var{name} is @code{nil}, this function modifies the default |
54023 | 2737 fontset, whose short name is @samp{fontset-default}. |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2738 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2739 @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
|
2740 @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
|
2741 @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
|
2742 (inclusive). |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2743 |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2744 @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
|
2745 @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
|
2746 |
52940
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2747 @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
|
2748 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
|
2749 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
|
2750 (possibly including an encoding name at the tail). |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2751 |
cac3cb68235c
(Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents:
52932
diff
changeset
|
2752 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
|
2753 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
|
2754 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
|
2755 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
2756 @smallexample |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2757 (set-fontset-font nil 'japanese-jisx0208 '(nil . "JISX0208.1983")) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
2758 @end smallexample |
52932
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2759 @end defun |
eb3f1895daff
(Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents:
52923
diff
changeset
|
2760 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2761 @defun char-displayable-p char |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2762 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
|
2763 @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
|
2764 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
|
2765 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2766 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
|
2767 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
|
2768 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
2769 |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2770 @node Fringes |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2771 @section Fringes |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
2772 @cindex fringes |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2773 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2774 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
|
2775 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
|
2776 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
|
2777 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2778 @menu |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2779 * 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
|
2780 * Fringe Indicators:: Displaying indicator icons in the window fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2781 * Fringe Cursors:: Displaying cursors in the right fringe. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2782 * 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
|
2783 * 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
|
2784 * 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
|
2785 @end menu |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2786 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
2787 @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
|
2788 @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
|
2789 |
65799
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2790 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
|
2791 of the window fringes. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2792 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2793 @defvar fringes-outside-margins |
65799
2d967531d264
(Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents:
65740
diff
changeset
|
2794 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
|
2795 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
|
2796 margins. @xref{Display Margins}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2797 @end defvar |
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 @defvar left-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2800 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
|
2801 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
|
2802 width from the window's frame. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2803 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2804 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2805 @defvar right-fringe-width |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2806 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
|
2807 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
|
2808 width from the window's frame. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2809 @end defvar |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2810 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2811 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
|
2812 buffer in a window. If you change them while the buffer is visible, |
54023 | 2813 you can call @code{set-window-buffer} to display it once again in the |
2814 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
|
2815 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2816 @defun set-window-fringes window left &optional right outside-margins |
54023 | 2817 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
|
2818 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
|
2819 |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2820 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
|
2821 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
|
2822 @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
|
2823 @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
|
2824 should appear outside of the display margins. |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2825 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2826 |
53929
3ef7a4a3c230
(Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents:
53829
diff
changeset
|
2827 @defun window-fringes &optional window |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2828 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
|
2829 @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
|
2830 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
|
2831 @var{right-width} @var{outside-margins})}. |
52141
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2832 @end defun |
a5d4d0a7b284
(Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents:
52002
diff
changeset
|
2833 |
69052
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 @node Fringe Indicators |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2836 @subsection Fringe Indicators |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2837 @cindex fringe indicators |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2838 @cindex indicators, fringe |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2839 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2840 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
|
2841 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
|
2842 continued lines, buffer boundaries, overlay arrow, etc. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2843 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2844 @defopt indicate-empty-lines |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2845 @cindex fringes, and empty line indication |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2846 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
|
2847 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
|
2848 displays. @xref{Fringes}. This variable is automatically |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2849 buffer-local in every buffer. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2850 @end defopt |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2851 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2852 @defvar indicate-buffer-boundaries |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2853 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
|
2854 window scrolling are indicated in the window fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2855 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2856 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
|
2857 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
|
2858 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
|
2859 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
|
2860 there is text below the screen. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2861 |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2862 There are three kinds of basic values: |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2863 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2864 @table @asis |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2865 @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
|
2866 Don't display any of these fringe icons. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2867 @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
|
2868 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
|
2869 @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
|
2870 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
|
2871 @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
|
2872 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
|
2873 and don't display the arrows. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2874 @end table |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2875 |
72758
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2876 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
|
2877 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
|
2878 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
|
2879 @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
|
2880 @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
|
2881 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
|
2882 and @code{nil}. |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2883 |
525ad9d19a8b
(Fringe Indicators): Update for last change in indicate-buffer-boundaries.
Richard M. Stallman <rms@gnu.org>
parents:
72571
diff
changeset
|
2884 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
|
2885 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
|
2886 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
|
2887 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
|
2888 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2889 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2890 @defvar default-indicate-buffer-boundaries |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2891 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
|
2892 @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
|
2893 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2894 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2895 @defvar fringe-indicator-alist |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2896 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
|
2897 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
|
2898 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2899 These symbols identify the logical fringe indicators: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2900 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2901 @table @asis |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2902 @item Truncation and continuation line indicators: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2903 @code{truncation}, @code{continuation}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2904 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2905 @item Buffer position indicators: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2906 @code{up}, @code{down}, |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2907 @code{top}, @code{bottom}, |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2908 @code{top-bottom}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2909 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2910 @item Empty line indicator: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2911 @code{empty-line}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2912 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2913 @item Overlay arrow indicator: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2914 @code{overlay-arrow}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2915 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2916 @item Unknown bitmap indicator: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2917 @code{unknown}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2918 @end table |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2919 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2920 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
|
2921 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
|
2922 fringe indicator. |
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 Here, @var{indicator} specifies the logical indicator type, and |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2925 @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
|
2926 [@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
|
2927 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
|
2928 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2929 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
|
2930 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
|
2931 @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
|
2932 `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
|
2933 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
|
2934 used in both left and right fringes. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2935 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2936 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
|
2937 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
|
2938 @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
|
2939 @code{default-fringe-indicator-alist} is used. |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2940 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2941 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
|
2942 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2943 |
69611
1d437dedbd3a
(Fringe Indicators): Fix typos.
Nick Roberts <nickrob@snap.net.nz>
parents:
69521
diff
changeset
|
2944 @defvar default-fringe-indicator-alist |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2945 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
|
2946 @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
|
2947 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2948 |
71638 | 2949 Standard fringe bitmaps for indicators: |
2950 @example | |
2951 left-arrow right-arrow up-arrow down-arrow | |
2952 left-curly-arrow right-curly-arrow | |
2953 left-triangle right-triangle | |
2954 top-left-angle top-right-angle | |
2955 bottom-left-angle bottom-right-angle | |
2956 left-bracket right-bracket | |
2957 filled-rectangle hollow-rectangle | |
2958 filled-square hollow-square | |
2959 vertical-bar horizontal-bar | |
2960 empty-line question-mark | |
2961 @end example | |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2962 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2963 @node Fringe Cursors |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2964 @subsection Fringe Cursors |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2965 @cindex fringe cursors |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2966 @cindex cursor, fringe |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2967 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2968 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
|
2969 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
|
2970 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
|
2971 the current buffer's cursor type. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2972 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2973 @table @asis |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2974 @item Logical cursor types: |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2975 @code{box} , @code{hollow}, @code{bar}, |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2976 @code{hbar}, @code{hollow-small}. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2977 @end table |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2978 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2979 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
|
2980 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
|
2981 display line. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2982 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2983 @defvar overflow-newline-into-fringe |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2984 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
|
2985 counting the final newline character) are not continued. Instead, |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
2986 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
|
2987 fringe. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2988 @end defvar |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
2989 |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2990 @defvar fringe-cursor-alist |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2991 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
|
2992 actual fringe bitmaps displayed in the right fringe. The value is an |
71663 | 2993 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
|
2994 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
|
2995 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
|
2996 @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
|
2997 for that logical cursor type. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2998 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
2999 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
|
3000 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
|
3001 (non-local) @code{default-fringes-indicator-alist} is used. |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3002 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3003 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3004 @defvar default-fringes-cursor-alist |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3005 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
|
3006 @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
|
3007 @end defvar |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3008 |
71638 | 3009 Standard bitmaps for displaying the cursor in right fringe: |
3010 @example | |
3011 filled-rectangle hollow-rectangle filled-square hollow-square | |
3012 vertical-bar horizontal-bar | |
3013 @end example | |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3014 |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3015 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3016 @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
|
3017 @subsection Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3018 @cindex fringe bitmaps |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3019 @cindex bitmaps, fringe |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3020 |
69052
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3021 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
|
3022 logical fringe indicators for truncated or continued lines, buffer |
0c26b31febaf
(Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents:
68946
diff
changeset
|
3023 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
|
3024 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
|
3025 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
|
3026 fringe bitmaps. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3027 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3028 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
|
3029 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
|
3030 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
|
3031 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
|
3032 @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
|
3033 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
|
3034 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
|
3035 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
|
3036 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
|
3037 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
|
3038 foreground color for the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3039 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3040 @defun fringe-bitmaps-at-pos &optional pos window |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3041 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
|
3042 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
|
3043 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
|
3044 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
|
3045 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
|
3046 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
|
3047 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3048 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
|
3049 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
|
3050 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
|
3051 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3052 @end defun |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3053 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3054 @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
|
3055 @subsection Customizing Fringe Bitmaps |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3056 |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3057 @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
|
3058 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
|
3059 or replaces an existing bitmap with that name. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3060 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3061 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
|
3062 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
|
3063 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
|
3064 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
|
3065 to the rightmost pixel of the bitmap. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3066 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3067 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
|
3068 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
|
3069 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
|
3070 @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
|
3071 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3072 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
|
3073 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
|
3074 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
|
3075 or @code{bottom}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3076 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3077 The @var{align} argument may also be a list @code{(@var{align} |
57225 | 3078 @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
|
3079 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
|
3080 @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
|
3081 height. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3082 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3083 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3084 @defun destroy-fringe-bitmap bitmap |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3085 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
|
3086 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
|
3087 restores the standard definition of that bitmap, instead of |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3088 eliminating it entirely. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3089 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3090 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3091 @defun set-fringe-bitmap-face bitmap &optional face |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3092 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
|
3093 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
|
3094 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
|
3095 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3096 @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
|
3097 @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
|
3098 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3099 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3100 @node Overlay Arrow |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3101 @subsection The Overlay Arrow |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
3102 @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
|
3103 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3104 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
|
3105 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
|
3106 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
|
3107 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
|
3108 @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
|
3109 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3110 @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
|
3111 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
|
3112 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
|
3113 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
|
3114 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
|
3115 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3116 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3117 @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
|
3118 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
|
3119 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
|
3120 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
|
3121 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
|
3122 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
|
3123 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
|
3124 overwritten. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3125 |
66341
8ad92df59512
(Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents:
66209
diff
changeset
|
3126 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
|
3127 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
|
3128 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
|
3129 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
|
3130 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
|
3131 @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
|
3132 @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
|
3133 @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
|
3134 @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
|
3135 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3136 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3137 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
|
3138 @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
|
3139 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3140 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
|
3141 @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
|
3142 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3143 @defvar overlay-arrow-variable-list |
61980
f3d536670495
Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61972
diff
changeset
|
3144 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
|
3145 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
|
3146 @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
|
3147 this list. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3148 @end defvar |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3149 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3150 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
|
3151 @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
|
3152 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
|
3153 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
|
3154 overlay arrow position. If either property is not set, the default |
71663 | 3155 @code{overlay-arrow-string} or @code{overlay-arrow} fringe indicator |
3156 is used. | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3157 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3158 @node Scroll Bars |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3159 @section Scroll Bars |
76837 | 3160 @cindex scroll bars |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3161 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3162 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
|
3163 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
|
3164 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
|
3165 @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
|
3166 meaning the default). @xref{Layout Parameters}. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3167 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3168 @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
|
3169 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
|
3170 @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
|
3171 @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
|
3172 @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
|
3173 (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
|
3174 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
|
3175 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
|
3176 @end defun |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3177 |
58883
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
3178 @vindex vertical-scroll-bar |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
3179 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
|
3180 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
|
3181 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
|
3182 @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
|
3183 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
|
3184 |
eb1bd3031b13
(Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents:
58496
diff
changeset
|
3185 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
|
3186 @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
|
3187 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3188 @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
|
3189 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
|
3190 @var{window}. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3191 |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3192 @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
|
3193 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
|
3194 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
|
3195 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
|
3196 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
|
3197 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3198 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
|
3199 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
|
3200 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
|
3201 selected window is used. |
52483
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3202 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3203 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3204 @defun window-scroll-bars &optional window |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3205 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
|
3206 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
|
3207 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
|
3208 @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
|
3209 @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
|
3210 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
|
3211 bar actually occupies. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3212 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3213 @var{horizontal-type} is not actually meaningful. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3214 @end defun |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3215 |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
3216 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
|
3217 @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
|
3218 @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
|
3219 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
|
3220 @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
|
3221 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
|
3222 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
|
3223 specifying the same buffer that is already displayed. |
3bbb565fa7ac
(Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents:
52401
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-mode |
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, controls whether and where |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3227 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
|
3228 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
|
3229 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
|
3230 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3231 |
60958
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3232 @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
|
3233 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
|
3234 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
|
3235 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
|
3236 @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
|
3237 @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
|
3238 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
|
3239 account. |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3240 @end defun |
85b21e63d5d4
(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents:
60868
diff
changeset
|
3241 |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3242 @defvar scroll-bar-width |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3243 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
|
3244 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
|
3245 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
|
3246 @end defvar |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
3247 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3248 @node Display Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3249 @section The @code{display} Property |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3250 @cindex display specification |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3251 @kindex display @r{(text property)} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3252 |
25875 | 3253 The @code{display} text property (or overlay property) is used to |
3254 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
|
3255 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
|
3256 display specification, or a list or vector containing several display |
79010
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3257 specifications. Display specifications in the same @code{display} |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3258 property value generally apply in parallel to the text they cover. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3259 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3260 If several sources (overlays and/or a text property) specify values |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3261 for the @code{display} property, only one of the values takes effect, |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3262 following the rules of @code{get-char-property}. @xref{Examining |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3263 Properties}. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3264 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3265 The rest of this section describes several kinds of |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3266 display specifications and what they mean. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3267 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3268 @menu |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3269 * Replacing Specs:: Display specs that replace the text. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3270 * Specified Space:: Displaying one space with a specified width. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3271 * Pixel Specification:: Specifying space width or height in pixels. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3272 * Other Display Specs:: Displaying an image; magnifying text; moving it |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3273 up or down on the page; adjusting the width |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3274 of spaces within text. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3275 * Display Margins:: Displaying text or images to the side of the main text. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3276 @end menu |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3277 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3278 @node Replacing Specs |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3279 @subsection Display Specs That Replace The Text |
78837
5c28c184a1f6
(Display Property): Clarify when multiple display specs work in
Richard M. Stallman <rms@gnu.org>
parents:
78835
diff
changeset
|
3280 |
5c28c184a1f6
(Display Property): Clarify when multiple display specs work in
Richard M. Stallman <rms@gnu.org>
parents:
78835
diff
changeset
|
3281 Some kinds of @code{display} specifications specify something to |
79010
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3282 display instead of the text that has the property. These are called |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3283 @dfn{replacing} display specifications. Emacs does not allow the user |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3284 to interactively move point into the middle of buffer text that is |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3285 replaced in this way. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3286 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3287 If a list of display specifications includes more than one replacing |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3288 display specification, the first overrides the rest. Replacing |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3289 display specifications make most other display specifications |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3290 irrelevant, since those don't apply to the replacement. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3291 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3292 For replacing display specifications, ``the text that has the |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3293 property'' means all the consecutive characters that have the same |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3294 Lisp object as their @code{display} property; these characters are |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3295 replaced as a single unit. By contrast, characters that have similar |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3296 but distinct Lisp objects as their @code{display} properties are |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3297 handled separately. Here's a function that illustrates this point: |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3298 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3299 @smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3300 (defun foo () |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3301 (goto-char (point-min)) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3302 (dotimes (i 5) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3303 (let ((string (concat "A"))) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3304 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3305 (forward-char 1) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3306 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3307 (forward-char 1)))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3308 @end smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3309 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3310 @noindent |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3311 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
|
3312 @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
|
3313 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
|
3314 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
|
3315 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
|
3316 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
|
3317 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
|
3318 results: |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3319 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3320 @smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3321 (defun foo () |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3322 (goto-char (point-min)) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3323 (dotimes (i 5) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3324 (let ((string (concat "A"))) |
78837
5c28c184a1f6
(Display Property): Clarify when multiple display specs work in
Richard M. Stallman <rms@gnu.org>
parents:
78835
diff
changeset
|
3325 (put-text-property (point) (+ 2 (point)) 'display string) |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3326 (put-text-property (point) (1+ (point)) 'display string) |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3327 (forward-char 2)))) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3328 @end smallexample |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3329 |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3330 @noindent |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3331 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
|
3332 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
|
3333 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
|
3334 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
|
3335 @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
|
3336 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3337 @node Specified Space |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3338 @subsection Specified Spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3339 @cindex spaces, specified height or width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3340 @cindex variable-width spaces |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3341 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3342 To display a space of specified width and/or height, use a display |
25875 | 3343 specification of the form @code{(space . @var{props})}, where |
3344 @var{props} is a property list (a list of alternating properties and | |
3345 values). You can put this property on one or more consecutive | |
3346 characters; a space of the specified height and width is displayed in | |
3347 place of @emph{all} of those characters. These are the properties you | |
44281 | 3348 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
|
3349 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3350 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3351 @item :width @var{width} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3352 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
|
3353 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
|
3354 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
|
3355 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3356 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3357 @item :relative-width @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3358 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
|
3359 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
|
3360 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
|
3361 character, multiplied by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3362 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3363 @item :align-to @var{hpos} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3364 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
|
3365 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
|
3366 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
|
3367 specification (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3368 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3369 |
44281 | 3370 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
|
3371 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
|
3372 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3373 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3374 @item :height @var{height} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3375 Specifies the height of the space. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3376 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
|
3377 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
|
3378 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
|
3379 (@pxref{Pixel Specification}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3380 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3381 @item :relative-height @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3382 Specifies the height of the space, multiplying the ordinary height |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3383 of the text having this display specification by @var{factor}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3384 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3385 @item :ascent @var{ascent} |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3386 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
|
3387 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
|
3388 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
|
3389 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
|
3390 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
|
3391 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3392 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3393 |
44281 | 3394 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
|
3395 |
60509
b6fee46c2fad
(Specified Space): Property :width is support on
Kim F. Storm <storm@cua.dk>
parents:
60503
diff
changeset
|
3396 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
|
3397 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
|
3398 are not. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3399 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3400 @node Pixel Specification |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3401 @subsection Pixel Specification for Spaces |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3402 @cindex spaces, pixel specification |
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 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
|
3405 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
|
3406 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
|
3407 as an absolute number of pixels. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3408 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3409 The following expressions are supported: |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3410 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3411 @smallexample |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3412 @group |
57274
271dfa08c2d0
(Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents:
57225
diff
changeset
|
3413 @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
|
3414 @var{num} ::= @var{integer} | @var{float} | @var{symbol} |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3415 @var{unit} ::= in | mm | cm | width | height |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3416 @end group |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3417 @group |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3418 @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
|
3419 | scroll-bar | text |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3420 @var{pos} ::= left | center | right |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3421 @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
|
3422 @var{op} ::= + | - |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3423 @end group |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3424 @end smallexample |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3425 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3426 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
|
3427 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
|
3428 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
|
3429 buffer-local variable binding is used. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3430 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3431 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
|
3432 pixels per inch, millimeter, and centimeter, respectively. The |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3433 @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
|
3434 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
|
3435 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
|
3436 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3437 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
|
3438 @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
|
3439 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
|
3440 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3441 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
|
3442 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
|
3443 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
|
3444 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3445 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
|
3446 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
|
3447 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
|
3448 position has been set (by the first occurrence of one of these |
57225 | 3449 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
|
3450 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
|
3451 the left-margin, use |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3452 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3453 @example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3454 :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
|
3455 @end example |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3456 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3457 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
|
3458 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
|
3459 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
|
3460 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3461 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
|
3462 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
|
3463 @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
|
3464 @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
|
3465 image. |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3466 |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3467 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
|
3468 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
|
3469 the value of the expressions. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3470 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3471 @node Other Display Specs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3472 @subsection Other Display Specifications |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3473 |
57221
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3474 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
|
3475 in the @code{display} text property. |
18bdf278f148
(Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents:
57202
diff
changeset
|
3476 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3477 @table @code |
60676
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3478 @item @var{string} |
44c74c24feca
(Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents:
60509
diff
changeset
|
3479 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
|
3480 |
68282
6efd3312bd38
(Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents:
68084
diff
changeset
|
3481 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
|
3482 @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
|
3483 |
68946
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3484 @item (image . @var{image-props}) |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63134
diff
changeset
|
3485 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
|
3486 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
|
3487 instead of the text that has the display specification. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3488 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3489 @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
|
3490 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
|
3491 (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
|
3492 @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
|
3493 @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
|
3494 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
|
3495 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
|
3496 of the entire image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3497 |
32467 | 3498 @item ((margin nil) @var{string}) |
3499 A display specification of this form means to display @var{string} | |
3500 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
|
3501 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
|
3502 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
|
3503 Margins}). |
36935 | 3504 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3505 @item (space-width @var{factor}) |
25875 | 3506 This display specification affects all the space characters within the |
3507 text that has the specification. It displays all of these spaces | |
3508 @var{factor} times as wide as normal. The element @var{factor} should | |
3509 be an integer or float. Characters other than spaces are not affected | |
3510 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
|
3511 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3512 @item (height @var{height}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3513 This display specification makes the text taller or shorter. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3514 Here are the possibilities for @var{height}: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3515 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3516 @table @asis |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3517 @item @code{(+ @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3518 This means to use a font that is @var{n} steps larger. A ``step'' is |
25875 | 3519 defined by the set of available fonts---specifically, those that match |
3520 what was otherwise specified for this text, in all attributes except | |
3521 height. Each size for which a suitable font is available counts as | |
3522 another step. @var{n} should be an integer. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3523 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3524 @item @code{(- @var{n})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3525 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
|
3526 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3527 @item a number, @var{factor} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3528 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
|
3529 as tall as the default font. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3530 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3531 @item a symbol, @var{function} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3532 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
|
3533 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
|
3534 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3535 @item anything else, @var{form} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3536 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
|
3537 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
|
3538 @code{height} bound to the current specified font height. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3539 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3540 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3541 @item (raise @var{factor}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3542 This kind of display specification raises or lowers the text |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3543 it applies to, relative to the baseline of the line. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3544 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3545 @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
|
3546 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
|
3547 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
|
3548 lower down. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3549 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3550 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
|
3551 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
|
3552 faces used for the text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3553 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3554 |
69849
85e6a1c82a54
(Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
69611
diff
changeset
|
3555 @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
|
3556 @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
|
3557 @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
|
3558 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
|
3559 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
|
3560 @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
|
3561 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
|
3562 @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
|
3563 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
|
3564 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
|
3565 @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
|
3566 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
|
3567 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
|
3568 string. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3569 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3570 @node Display Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3571 @subsection Displaying in the Margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3572 @cindex display margins |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3573 @cindex margins, display |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3574 |
79010
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3575 A buffer can have blank areas called @dfn{display margins} on the |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3576 left and on the right. Ordinary text never appears in these areas, |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3577 but you can put things into the display margins using the |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3578 @code{display} property. There is currently no way to make text or |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3579 images in the margin mouse-sensitive. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3580 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3581 The way to display something in the margins is to specify it in a |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3582 margin display specification in the @code{display} property of some |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3583 text. This is a replacing display specification, meaning that the |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3584 text you put it on does not get displayed; the margin display appears, |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3585 but that text does not. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3586 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3587 A margin display specification looks like @code{((margin |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3588 right-margin) @var{spec}} or @code{((margin left-margin) @var{spec})}. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3589 Here, @var{spec} is another display specification that says what to |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3590 display in the margin. Typically it is a string of text to display, |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3591 or an image descriptor. |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3592 |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3593 To display something in the margin @emph{in association with} |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3594 certain buffer text, without altering or preventing the display of |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3595 that text, put a @code{before-string} property on the text and put the |
3d90e1da8878
(Display Margins): Correct the description of margin display specifications.
Richard M. Stallman <rms@gnu.org>
parents:
78974
diff
changeset
|
3596 margin display specification on the contents of the before-string. |
42297
c4f9d48801a8
Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents:
42082
diff
changeset
|
3597 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3598 Before the display margins can display anything, you must give |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3599 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
|
3600 variables: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3601 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3602 @defvar left-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3603 This variable specifies the width of the left margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3604 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3605 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3606 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3607 @defvar right-margin-width |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3608 This variable specifies the width of the right margin. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3609 It is buffer-local in all buffers. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3610 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3611 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3612 Setting these variables does not immediately affect the window. These |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3613 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
|
3614 Thus, you can make changes take effect by calling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3615 @code{set-window-buffer}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3616 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3617 You can also set the margin widths immediately. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3618 |
36935 | 3619 @defun set-window-margins window left &optional right |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3620 This function specifies the margin widths for window @var{window}. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48948
diff
changeset
|
3621 The argument @var{left} controls the left margin and |
36935 | 3622 @var{right} controls the right margin (default @code{0}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3623 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3624 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3625 @defun window-margins &optional window |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3626 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
|
3627 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
|
3628 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
|
3629 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3630 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3631 @node Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3632 @section Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3633 @cindex images in buffers |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3634 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3635 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
|
3636 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
|
3637 property of text that is displayed (@pxref{Display Property}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3638 |
72571
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3639 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
|
3640 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
|
3641 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
|
3642 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
|
3643 @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
|
3644 displayed (@pxref{Display Feature Testing}). |
871eeda78fd7
* display.texi (Images): Add xrref to display-images-p.
Chong Yidong <cyd@stupidchicken.com>
parents:
72208
diff
changeset
|
3645 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3646 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
|
3647 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
|
3648 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
|
3649 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
|
3650 can be used to modify the set of known names for these dynamic |
57225 | 3651 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
|
3652 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3653 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
|
3654 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring |
76828 | 3655 @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
|
3656 @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
|
3657 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
|
3658 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3659 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
|
3660 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
|
3661 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3662 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3663 @defvar image-types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3664 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
|
3665 potentially supported in the current configuration. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3666 @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
|
3667 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
|
3668 unavailable dynamic libraries, for example). |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3669 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3670 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
|
3671 @code{image-type-available-p}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3672 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3673 |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3674 @defvar image-library-alist |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3675 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
|
3676 display them. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3677 |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3678 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
|
3679 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
|
3680 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
|
3681 external libraries to load. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3682 |
56185
4f36c90f5404
(Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents:
56109
diff
changeset
|
3683 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
|
3684 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
|
3685 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
|
3686 they're always supported. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3687 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3688 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
|
3689 into Emacs. |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3690 @end defvar |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3691 |
78661
048b9f8ae3b7
(Images): Delete redundant @findex.
Richard M. Stallman <rms@gnu.org>
parents:
78455
diff
changeset
|
3692 @defun image-type-available-p type |
56437
bd1f1cbf959f
(Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents:
56233
diff
changeset
|
3693 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
|
3694 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
|
3695 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
|
3696 @code{image-types}. |
56109
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3697 |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3698 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
|
3699 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
|
3700 @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
|
3701 @end defun |
53374ab0a92d
(Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents:
56020
diff
changeset
|
3702 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3703 @menu |
25875 | 3704 * Image Descriptors:: How to specify an image for use in @code{:display}. |
3705 * XBM Images:: Special features for XBM format. | |
3706 * XPM Images:: Special features for XPM format. | |
3707 * GIF Images:: Special features for GIF format. | |
76828 | 3708 * PostScript Images:: Special features for PostScript format. |
25875 | 3709 * Other Image Types:: Various other formats are supported. |
3710 * Defining Images:: Convenient ways to define an image for later use. | |
3711 * Showing Images:: Convenient ways to display an image once it is defined. | |
3712 * Image Cache:: Internal mechanisms of image display. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3713 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3714 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3715 @node Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3716 @subsection Image Descriptors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3717 @cindex image descriptor |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3718 |
68946
956ccc6ec126
(Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68708
diff
changeset
|
3719 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
|
3720 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
|
3721 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
|
3722 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
|
3723 that have any special meaning are certain symbols, all of them keywords. |
26400 | 3724 |
3725 Every image descriptor must contain the property @code{:type | |
3726 @var{type}} to specify the format of the image. The value of @var{type} | |
3727 should be an image type symbol; for example, @code{xpm} for an image in | |
3728 XPM format. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3729 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3730 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
|
3731 types: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3732 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3733 @table @code |
36730
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3734 @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
|
3735 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
|
3736 @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
|
3737 in @code{data-directory}. |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3738 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3739 @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
|
3740 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
|
3741 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
|
3742 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
|
3743 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
|
3744 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3745 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
|
3746 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
|
3747 @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
|
3748 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
|
3749 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
|
3750 |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3751 @item :margin @var{margin} |
1c038a1a02a1
Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents:
36351
diff
changeset
|
3752 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
|
3753 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
|
3754 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
|
3755 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
|
3756 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
|
3757 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
|
3758 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3759 @item :ascent @var{ascent} |
29151 | 3760 The @code{:ascent} property specifies the amount of the image's |
3761 height to use for its ascent---that is, the part above the baseline. | |
3762 The value, @var{ascent}, must be a number in the range 0 to 100, or | |
3763 the symbol @code{center}. | |
3764 | |
3765 If @var{ascent} is a number, that percentage of the image's height is | |
3766 used for its ascent. | |
3767 | |
3768 If @var{ascent} is @code{center}, the image is vertically centered | |
3769 around a centerline which would be the vertical centerline of text drawn | |
3770 at the position of the image, in the manner specified by the text | |
3771 properties and overlays that apply to the image. | |
3772 | |
3773 If this property is omitted, it defaults to 50. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3774 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3775 @item :relief @var{relief} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3776 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
|
3777 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
|
3778 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
|
3779 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
|
3780 an unpressed button. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3781 |
35364 | 3782 @item :conversion @var{algorithm} |
3783 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
|
3784 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
|
3785 displayed; the value, @var{algorithm}, specifies which algorithm. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3786 |
33996 | 3787 @table @code |
3788 @item laplace | |
3789 @itemx emboss | |
3790 Specifies the Laplace edge detection algorithm, which blurs out small | |
3791 differences in color while highlighting larger differences. People | |
3792 sometimes consider this useful for displaying the image for a | |
3793 ``disabled'' button. | |
3794 | |
3795 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
3796 Specifies a general edge-detection algorithm. @var{matrix} must be | |
3797 either a nine-element list or a nine-element vector of numbers. A pixel | |
3798 at position @math{x/y} in the transformed image is computed from | |
3799 original pixels around that position. @var{matrix} specifies, for each | |
3800 pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
3801 will influence the transformed pixel; element @math{0} specifies the | |
3802 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
3803 the pixel at @math{x/y-1} etc., as shown below: | |
3804 @iftex | |
3805 @tex | |
3806 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
3807 x-1/y & x/y & x+1/y \cr | |
3808 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
3809 @end tex | |
3810 @end iftex | |
3811 @ifnottex | |
3812 @display | |
3813 (x-1/y-1 x/y-1 x+1/y-1 | |
3814 x-1/y x/y x+1/y | |
3815 x-1/y+1 x/y+1 x+1/y+1) | |
3816 @end display | |
3817 @end ifnottex | |
3818 | |
3819 The resulting pixel is computed from the color intensity of the color | |
3820 resulting from summing up the RGB values of surrounding pixels, | |
3821 multiplied by the specified factors, and dividing that sum by the sum | |
3822 of the factors' absolute values. | |
3823 | |
3824 Laplace edge-detection currently uses a matrix of | |
3825 @iftex | |
3826 @tex | |
3827 $$\pmatrix{1 & 0 & 0 \cr | |
3828 0& 0 & 0 \cr | |
3829 9 & 9 & -1 \cr}$$ | |
3830 @end tex | |
3831 @end iftex | |
3832 @ifnottex | |
3833 @display | |
3834 (1 0 0 | |
3835 0 0 0 | |
3836 9 9 -1) | |
3837 @end display | |
3838 @end ifnottex | |
3839 | |
3840 Emboss edge-detection uses a matrix of | |
3841 @iftex | |
3842 @tex | |
3843 $$\pmatrix{ 2 & -1 & 0 \cr | |
3844 -1 & 0 & 1 \cr | |
3845 0 & 1 & -2 \cr}$$ | |
3846 @end tex | |
3847 @end iftex | |
3848 @ifnottex | |
3849 @display | |
3850 ( 2 -1 0 | |
3851 -1 0 1 | |
3852 0 1 -2) | |
3853 @end display | |
3854 @end ifnottex | |
3855 | |
3856 @item disabled | |
71957
61cb5aae3bc3
Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71882
diff
changeset
|
3857 Specifies transforming the image so that it looks ``disabled.'' |
33996 | 3858 @end table |
3859 | |
3860 @item :mask @var{mask} | |
3861 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
3862 a clipping mask for the image, so that the background of a frame is | |
3863 visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
3864 is @code{t}, determine the background color of the image by looking at | |
3865 the four corners of the image, assuming the most frequently occurring | |
3866 color from the corners is the background color of the image. Otherwise, | |
3867 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
3868 specifying the color to assume for the background of the image. | |
3869 | |
51652
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
3870 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
|
3871 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
|
3872 specifying @code{:mask nil}. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3873 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3874 @item :pointer @var{shape} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3875 This specifies the pointer shape when the mouse pointer is over this |
57225 | 3876 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
|
3877 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3878 @item :map @var{map} |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3879 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
|
3880 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3881 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
|
3882 @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
|
3883 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
|
3884 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3885 A rectangle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3886 @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
|
3887 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
|
3888 corners of the rectangle area. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3889 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3890 A circle is a cons |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3891 @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
|
3892 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
|
3893 be a float or integer. |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3894 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3895 A polygon is a cons |
57201
2950fcfcfa44
Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57193
diff
changeset
|
3896 @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
|
3897 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
|
3898 |
70843
4f398d726c7c
(Pointer Shape): Node deleted.
Richard M. Stallman <rms@gnu.org>
parents:
70604
diff
changeset
|
3899 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
|
3900 @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
|
3901 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
|
3902 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
|
3903 it is on the hot-spot. |
57225 | 3904 @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
|
3905 |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
3906 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
|
3907 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
|
3908 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
|
3909 @var{id} is @code{area4}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3910 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3911 |
33996 | 3912 @defun image-mask-p spec &optional frame |
3913 This function returns @code{t} if image @var{spec} has a mask bitmap. | |
3914 @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
|
3915 @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
|
3916 (@pxref{Input Focus}). |
33996 | 3917 @end defun |
3918 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3919 @node XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3920 @subsection XBM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3921 @cindex XBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3922 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3923 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
|
3924 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
|
3925 always supported. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3926 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3927 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
|
3928 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3929 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3930 @item :foreground @var{foreground} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3931 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
|
3932 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
|
3933 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
|
3934 foreground color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3935 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3936 @item :background @var{background} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3937 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
|
3938 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
|
3939 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
|
3940 background color. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3941 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3942 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3943 If you specify an XBM image using data within Emacs instead of an |
28792 | 3944 external file, use the following three properties: |
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 |
28792 | 3947 @item :data @var{data} |
3948 The value, @var{data}, specifies the contents of the image. | |
3949 There are three formats you can use for @var{data}: | |
3950 | |
3951 @itemize @bullet | |
3952 @item | |
3953 A vector of strings or bool-vectors, each specifying one line of the | |
3954 image. Do specify @code{:height} and @code{:width}. | |
3955 | |
3956 @item | |
3957 A string containing the same byte sequence as an XBM file would contain. | |
3958 You must not specify @code{:height} and @code{:width} in this case, | |
3959 because omitting them is what indicates the data has the format of an | |
3960 XBM file. The file contents specify the height and width of the image. | |
3961 | |
3962 @item | |
3963 A string or a bool-vector containing the bits of the image (plus perhaps | |
3964 some extra bits at the end that will not be used). It should contain at | |
3965 least @var{width} * @code{height} bits. In this case, you must specify | |
3966 @code{:height} and @code{:width}, both to indicate that the string | |
3967 contains just the bits rather than a whole XBM file, and to specify the | |
3968 size of the image. | |
3969 @end itemize | |
3970 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3971 @item :width @var{width} |
28792 | 3972 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
|
3973 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3974 @item :height @var{height} |
28792 | 3975 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
|
3976 @end table |
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 @node XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3979 @subsection XPM Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3980 @cindex XPM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3981 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3982 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
|
3983 additional image property @code{:color-symbols} is also meaningful with |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
3984 the @code{xpm} image type: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3985 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3986 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3987 @item :color-symbols @var{symbols} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3988 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
|
3989 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
|
3990 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
|
3991 specifies the actual color to use for displaying that name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3992 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3993 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3994 @node GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3995 @subsection GIF Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3996 @cindex GIF |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3997 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
3998 For GIF images, specify image type @code{gif}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
3999 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4000 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4001 @item :index @var{index} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4002 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
|
4003 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
|
4004 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
|
4005 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
|
4006 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4007 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4008 @ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4009 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
|
4010 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
|
4011 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
|
4012 every 0.1 seconds. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4013 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4014 (defun show-anim (file max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4015 "Display multi-image GIF file FILE which contains MAX subimages." |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4016 (display-anim (current-buffer) file 0 max t)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4017 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4018 (defun display-anim (buffer file idx max first-time) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4019 (when (= idx max) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4020 (setq idx 0)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4021 (let ((img (create-image file nil :image idx))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4022 (save-excursion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4023 (set-buffer buffer) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4024 (goto-char (point-min)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4025 (unless first-time (delete-char 1)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4026 (insert-image img)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4027 (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
|
4028 @end ignore |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4029 |
76828 | 4030 @node PostScript Images |
4031 @subsection PostScript Images | |
4032 @cindex postscript images | |
4033 | |
4034 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
|
4035 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
|
4036 these three properties: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4037 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4038 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4039 @item :pt-width @var{width} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4040 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
|
4041 points (1/72 inch). @var{width} must be an integer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4042 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4043 @item :pt-height @var{height} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4044 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
|
4045 (1/72 inch). @var{height} must be an integer. |
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 @item :bounding-box @var{box} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4048 The value, @var{box}, must be a list or vector of four integers, which |
76828 | 4049 specifying the bounding box of the PostScript image, analogous to the |
4050 @samp{BoundingBox} comment found in PostScript files. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4051 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4052 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4053 %%BoundingBox: 22 171 567 738 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4054 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4055 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4056 |
76828 | 4057 Displaying PostScript images from Lisp data is not currently |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
4058 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
|
4059 See the @file{etc/NEWS} file to make sure. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
4060 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4061 @node Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4062 @subsection Other Image Types |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4063 @cindex PBM |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4064 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4065 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
|
4066 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
|
4067 image properties are supported. |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4068 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4069 @table @code |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4070 @item :foreground @var{foreground} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4071 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
|
4072 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
|
4073 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
|
4074 foreground color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4075 |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4076 @item :background @var{background} |
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4077 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
|
4078 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
|
4079 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
|
4080 background color. |
32552
070ca96fa546
(Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents:
32467
diff
changeset
|
4081 @end table |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4082 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26986
diff
changeset
|
4083 For JPEG images, specify image type @code{jpeg}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4084 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4085 For TIFF images, specify image type @code{tiff}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4086 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4087 For PNG images, specify image type @code{png}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4088 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4089 @node Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4090 @subsection Defining Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4091 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4092 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
|
4093 @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
|
4094 |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
4095 @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
|
4096 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
|
4097 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
|
4098 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
|
4099 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
|
4100 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4101 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
|
4102 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
|
4103 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
|
4104 from the file's name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4105 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4106 The remaining arguments, @var{props}, specify additional image |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4107 properties---for example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4108 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4109 @example |
59574
9ce057395159
(Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents:
59505
diff
changeset
|
4110 (create-image "foo.xpm" 'xpm nil :heuristic-mask t) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4111 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4112 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4113 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
|
4114 supported. Otherwise it returns an image descriptor. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4115 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4116 |
41058
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4117 @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
|
4118 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
|
4119 @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
|
4120 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
|
4121 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4122 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
|
4123 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
|
4124 @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
|
4125 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
|
4126 @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
|
4127 @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
|
4128 example: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4129 |
25875 | 4130 @example |
4131 (defimage test-image | |
46338
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
4132 ((:type xpm :file "~/test1.xpm") |
6cf0fbc1d7da
defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents:
46245
diff
changeset
|
4133 (:type xbm :file "~/test1.xbm"))) |
25875 | 4134 @end example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4135 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4136 @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
|
4137 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
|
4138 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
|
4139 stored in @var{symbol}. |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4140 |
3532d3226828
(Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents:
40469
diff
changeset
|
4141 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
|
4142 as @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4143 @end defmac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4144 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4145 @defun find-image specs |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4146 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
|
4147 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
|
4148 |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4149 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
|
4150 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
|
4151 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
|
4152 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
|
4153 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
|
4154 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
|
4155 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
|
4156 @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
|
4157 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
|
4158 |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4159 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
|
4160 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4161 |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4162 @defvar image-load-path |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4163 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
|
4164 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
|
4165 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
|
4166 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
|
4167 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
|
4168 |
65560
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4169 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
|
4170 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
|
4171 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
|
4172 @code{load-path}. Subdirectories are not automatically included in |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4173 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
|
4174 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
|
4175 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
|
4176 should specify the image as follows: |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4177 |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4178 @example |
65560
9007bcbba781
(Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
65546
diff
changeset
|
4179 (defimage foo-image '((:type xpm :file "foo/bar.xpm"))) |
65546
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4180 @end example |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4181 @end defvar |
6759056e7603
Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents:
65369
diff
changeset
|
4182 |
69418
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4183 @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
|
4184 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
|
4185 Lisp package @var{library}. |
3a3fa8d383e2
(Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
69517
diff
changeset
|
4186 |
77123 | 4187 The function searches for @var{image} first using @code{image-load-path}, |
4188 excluding @file{@code{data-directory}/images}, and then in | |
71638 | 4189 @code{load-path}, followed by a path suitable for @var{library}, which |
4190 includes @file{../../etc/images} and @file{../etc/images} relative to | |
4191 the library file itself, and finally in | |
4192 @file{@code{data-directory}/images}. | |
69462
831f4f793f95
(Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents:
69421
diff
changeset
|
4193 |
69464
68172dbc9679
(Defining Images): Clean up last change.
Richard M. Stallman <rms@gnu.org>
parents:
69462
diff
changeset
|
4194 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
|
4195 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
|
4196 @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
|
4197 @code{load-path}. |
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4198 |
279f737753d8
(Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents:
69464
diff
changeset
|
4199 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
|
4200 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
|
4201 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
|
4202 |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4203 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
|
4204 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
|
4205 |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4206 @example |
71638 | 4207 (defvar image-load-path) ; shush compiler |
4208 (let* ((load-path (image-load-path-for-library | |
4209 "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
|
4210 (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
|
4211 (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
|
4212 image-load-path)))) |
69418
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4213 (mh-tool-bar-folder-buttons-init)) |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4214 @end example |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4215 @end defun |
2f43ac9fe122
(Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents:
69067
diff
changeset
|
4216 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4217 @node Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4218 @subsection Showing Images |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4219 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4220 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
|
4221 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
|
4222 section. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4223 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4224 @defun insert-image image &optional string area slice |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4225 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
|
4226 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
|
4227 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
|
4228 @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
|
4229 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
|
4230 @code{insert-image} uses @code{" "} by default. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4231 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4232 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
|
4233 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
|
4234 @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
|
4235 @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
|
4236 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4237 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4238 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
|
4239 @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
|
4240 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
|
4241 @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
|
4242 @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
|
4243 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
|
4244 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
|
4245 image. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4246 |
25875 | 4247 Internally, this function inserts @var{string} in the buffer, and gives |
4248 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
|
4249 Property}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4250 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4251 |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4252 @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
|
4253 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
|
4254 @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
|
4255 equally sized slices. |
57193
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4256 @end defun |
714a83d1ea32
(Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents:
56451
diff
changeset
|
4257 |
29471 | 4258 @defun put-image image pos &optional string area |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4259 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
|
4260 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
|
4261 marker. It specifies the buffer position where the image should appear. |
29471 | 4262 The argument @var{string} specifies the text that should hold the image |
4263 as an alternative to the default. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4264 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4265 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
|
4266 by @code{create-image} or stored by @code{defimage}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4267 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4268 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
|
4269 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
|
4270 @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
|
4271 @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
|
4272 buffer's text. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4273 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4274 Internally, this function creates an overlay, and gives it a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4275 @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
|
4276 property whose value is the image. (Whew!) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4277 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4278 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4279 @defun remove-images start end &optional buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4280 This function removes images in @var{buffer} between positions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4281 @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
|
4282 images are removed from the current buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4283 |
27331
be0a552c8320
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
4284 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
|
4285 @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
|
4286 @code{insert-image} or in other ways. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4287 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4288 |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4289 @defun image-size spec &optional pixels frame |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4290 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
|
4291 @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
|
4292 specification. @var{pixels} non-@code{nil} means return sizes |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
4293 measured in pixels, otherwise return sizes measured in canonical |
55fb0658914a
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
51000
diff
changeset
|
4294 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
|
4295 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
|
4296 @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
|
4297 Focus}). |
31373
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4298 @end defun |
a3fd71daf442
help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents:
29471
diff
changeset
|
4299 |
66197
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4300 @defvar max-image-size |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4301 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
|
4302 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
|
4303 larger than this limit. |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4304 |
97afbe22dea4
(Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents:
66197
diff
changeset
|
4305 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
|
4306 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
|
4307 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
|
4308 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
|
4309 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
|
4310 |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4311 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
|
4312 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
|
4313 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
|
4314 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
|
4315 @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
|
4316 @end defvar |
53c764d16ccf
* display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents:
66143
diff
changeset
|
4317 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4318 @node Image Cache |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4319 @subsection Image Cache |
76835 | 4320 @cindex image cache |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4321 |
78455
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4322 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
|
4323 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
|
4324 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
|
4325 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
|
4326 from the cache; otherwise, Emacs loads the image normally. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4327 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4328 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
|
4329 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
|
4330 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
|
4331 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
|
4332 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
|
4333 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
|
4334 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
|
4335 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
|
4336 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
|
4337 image using @code{image-refresh}. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4338 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4339 @defun image-refresh spec &optional frame |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4340 This function refreshes any images having image specifications |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4341 @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
|
4342 @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
|
4343 the refresh is applied to all existing frames. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4344 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4345 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
|
4346 @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
|
4347 displayed, Emacs will load the image again. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4348 @end defun |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4349 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4350 @defun clear-image-cache &optional frame |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4351 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
|
4352 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
|
4353 all frames' caches are cleared. |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4354 @end defun |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4355 |
cf26f3823573
(Image Cache): Document image-refresh.
Chong Yidong <cyd@stupidchicken.com>
parents:
78146
diff
changeset
|
4356 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
|
4357 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
|
4358 associated memory. |
28770 | 4359 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4360 @defvar image-cache-eviction-delay |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4361 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
|
4362 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
|
4363 length of time, Emacs removes it from the image cache. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4364 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4365 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
|
4366 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
|
4367 debugging. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4368 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
4369 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4370 @node Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4371 @section Buttons |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4372 @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
|
4373 @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
|
4374 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4375 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
|
4376 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
|
4377 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
|
4378 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
|
4379 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4380 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
|
4381 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
|
4382 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
|
4383 |
71748 | 4384 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
|
4385 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
|
4386 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
|
4387 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
|
4388 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4389 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
|
4390 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
|
4391 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
|
4392 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
|
4393 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
|
4394 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
|
4395 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
|
4396 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
|
4397 entries). |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4398 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4399 @menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4400 * 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
|
4401 * Button Types:: Defining common properties for classes of buttons. |
55246 | 4402 * 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
|
4403 * 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
|
4404 * 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
|
4405 @end menu |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4406 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4407 @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
|
4408 @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
|
4409 @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
|
4410 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4411 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
|
4412 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
|
4413 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
|
4414 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
|
4415 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4416 @table @code |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4417 @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
|
4418 @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
|
4419 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
|
4420 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
|
4421 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
|
4422 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4423 @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
|
4424 @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
|
4425 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
|
4426 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
|
4427 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
|
4428 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
|
4429 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4430 @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
|
4431 @kindex face @r{(button property)} |
55246 | 4432 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
|
4433 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
|
4434 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4435 @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
|
4436 @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
|
4437 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
|
4438 mouse-overs (merged with the usual button face); by default this is |
55246 | 4439 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
|
4440 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4441 @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
|
4442 @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
|
4443 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
|
4444 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
|
4445 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
|
4446 @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
|
4447 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4448 @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
|
4449 @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
|
4450 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
|
4451 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
|
4452 @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
|
4453 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4454 @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
|
4455 @kindex help-index @r{(button property)} |
55246 | 4456 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
|
4457 @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
|
4458 |
59467
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4459 @item follow-link |
9c3931bf6cd0
(Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents:
59463
diff
changeset
|
4460 @kindex follow-link @r{(button property)} |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4461 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
|
4462 on this button, @xref{Links and Mouse-1}. |
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4463 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4464 @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
|
4465 @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
|
4466 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
|
4467 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
|
4468 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
|
4469 @end table |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4470 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4471 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
|
4472 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
|
4473 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4474 @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
|
4475 @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
|
4476 @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
|
4477 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4478 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
|
4479 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
|
4480 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
|
4481 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
|
4482 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
|
4483 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4484 @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
|
4485 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
|
4486 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
|
4487 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
|
4488 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
|
4489 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
|
4490 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4491 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
|
4492 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
|
4493 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
|
4494 @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
|
4495 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
|
4496 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4497 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4498 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
|
4499 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
|
4500 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
|
4501 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
|
4502 |
f641b341c5ec
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents:
53467
diff
changeset
|
4503 @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
|
4504 @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
|
4505 @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
|
4506 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4507 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
|
4508 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
|
4509 initialized from the button's type (which defaults to the built-in |
55246 | 4510 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
|
4511 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
|
4512 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
|
4513 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
|
4514 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4515 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
|
4516 those that add button properties to an existing region of a buffer, |
68084 | 4517 called @code{make-...button}, and those that also insert the button |
4518 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
|
4519 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4520 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
|
4521 @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
|
4522 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
|
4523 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
|
4524 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
|
4525 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
|
4526 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
|
4527 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
|
4528 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4529 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
|
4530 (@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
|
4531 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4532 @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
|
4533 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
|
4534 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
|
4535 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4536 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4537 @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
|
4538 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
|
4539 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
|
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 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4542 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
|
4543 (@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
|
4544 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
|
4545 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
|
4546 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
|
4547 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
|
4548 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
|
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 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
|
4551 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
|
4552 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
|
4553 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4554 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4555 @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
|
4556 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
|
4557 properties. |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4558 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4559 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4560 @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
|
4561 @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
|
4562 @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
|
4563 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4564 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
|
4565 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
|
4566 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
|
4567 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4568 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
|
4569 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
|
4570 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
|
4571 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
|
4572 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
|
4573 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4574 @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
|
4575 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
|
4576 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4577 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4578 @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
|
4579 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
|
4580 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4581 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4582 @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
|
4583 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
|
4584 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4585 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4586 @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
|
4587 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
|
4588 @end defun |
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 @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
|
4591 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
|
4592 @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
|
4593 @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
|
4594 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
|
4595 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4596 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4597 @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
|
4598 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
|
4599 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4600 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4601 @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
|
4602 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
|
4603 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4604 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4605 @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
|
4606 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
|
4607 @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
|
4608 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4609 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4610 @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
|
4611 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
|
4612 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4613 |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4614 @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
|
4615 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
|
4616 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4617 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4618 @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
|
4619 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
|
4620 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4621 |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4622 @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
|
4623 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
|
4624 @end defun |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
4625 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4626 @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
|
4627 @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
|
4628 @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
|
4629 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4630 These are commands and functions for locating and operating on |
55246 | 4631 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
|
4632 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4633 @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
|
4634 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
|
4635 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
|
4636 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
|
4637 @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
|
4638 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
|
4639 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
|
4640 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
|
4641 |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4642 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
|
4643 @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
|
4644 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
|
4645 @xref{Links and Mouse-1}. |
59505
19b4e3d63aed
(Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents:
59493
diff
changeset
|
4646 |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4647 @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
|
4648 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
|
4649 @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
|
4650 @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
|
4651 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
|
4652 @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
|
4653 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
|
4654 @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
|
4655 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
|
4656 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
|
4657 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
|
4658 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4659 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4660 @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
|
4661 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
|
4662 @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
|
4663 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
|
4664 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
|
4665 @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
|
4666 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
|
4667 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
|
4668 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4669 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4670 @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
|
4671 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
|
4672 @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
|
4673 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
|
4674 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
|
4675 @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
|
4676 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
|
4677 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
|
4678 @end deffn |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4679 |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4680 @defun next-button pos &optional count-current |
77024 | 4681 @defunx previous-button pos &optional count-current |
4682 Return the next button after (for @code{next-button} or before (for | |
4683 @code{previous-button}) position @var{pos} in the current buffer. If | |
4684 @var{count-current} is non-@code{nil}, count any button at @var{pos} | |
4685 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
|
4686 @end defun |
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
4687 |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4688 @node Abstract Display |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4689 @section Abstract Display |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4690 @cindex ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4691 @cindex display, abstract |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4692 @cindex display, arbitrary objects |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4693 @cindex model/view/controller |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4694 @cindex view part, model/view/controller |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4695 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4696 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
|
4697 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
|
4698 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
|
4699 ``model/view/controller'' design paradigm. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4700 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4701 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
|
4702 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
|
4703 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
|
4704 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
|
4705 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
|
4706 Specifically, an ewoc contains information on: |
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 @itemize @bullet |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4709 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4710 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
|
4711 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4712 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4713 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
|
4714 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4715 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4716 The header and footer strings. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4717 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4718 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4719 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
|
4720 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4721 @itemize |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4722 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4723 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
|
4724 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4725 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4726 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
|
4727 @end itemize |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4728 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4729 @item |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4730 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
|
4731 inserting the textual representation of a data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4732 element value into the current buffer. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4733 @end itemize |
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 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
|
4736 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
|
4737 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
|
4738 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
|
4739 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
|
4740 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
|
4741 Functions}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4742 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4743 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
|
4744 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
|
4745 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
|
4746 new value in its place, like so: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4747 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4748 @lisp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4749 (ewoc-data @var{node}) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4750 @result{} value |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4751 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4752 (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
|
4753 @result{} @var{new-value} |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4754 @end lisp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4755 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4756 @noindent |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4757 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
|
4758 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
|
4759 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
|
4760 uses the latter approach. |
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 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
|
4763 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
|
4764 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
|
4765 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
|
4766 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
|
4767 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
|
4768 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
|
4769 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4770 @menu |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4771 * Abstract Display Functions:: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4772 * Abstract Display Example:: |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4773 @end menu |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4774 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4775 @node Abstract Display Functions |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4776 @subsection Abstract Display Functions |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4777 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4778 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
|
4779 structures described above (@pxref{Abstract Display}), while |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4780 @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
|
4781 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4782 @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
|
4783 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
|
4784 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
|
4785 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
|
4786 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
|
4787 @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
|
4788 Ewoc package's internal mechanisms). |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4789 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4790 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
|
4791 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
|
4792 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
|
4793 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
|
4794 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
|
4795 to do nothing for those nodes. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4796 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4797 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
|
4798 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
|
4799 @code{ewoc-create}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4800 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4801 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4802 @defun ewoc-buffer ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4803 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
|
4804 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4805 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4806 @defun ewoc-get-hf ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4807 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
|
4808 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
|
4809 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4810 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4811 @defun ewoc-set-hf ewoc header footer |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4812 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
|
4813 @var{header} and @var{footer}, respectively. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4814 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4815 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4816 @defun ewoc-enter-first ewoc data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4817 @defunx ewoc-enter-last ewoc data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4818 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
|
4819 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
|
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-enter-before ewoc node data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4823 @defunx ewoc-enter-after ewoc node data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4824 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
|
4825 @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
|
4826 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4827 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4828 @defun ewoc-prev ewoc node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4829 @defunx ewoc-next ewoc node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4830 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
|
4831 in @var{ewoc}. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4832 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4833 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4834 @defun ewoc-nth ewoc n |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4835 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
|
4836 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
|
4837 @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
|
4838 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4839 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4840 @defun ewoc-data node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4841 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
|
4842 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4843 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4844 @defun ewoc-set-data node data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4845 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
|
4846 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4847 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4848 @defun ewoc-locate ewoc &optional pos guess |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4849 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
|
4850 @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
|
4851 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
|
4852 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
|
4853 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
|
4854 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
|
4855 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
|
4856 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4857 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4858 @defun ewoc-location node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4859 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
|
4860 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4861 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4862 @defun ewoc-goto-prev ewoc arg |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4863 @defunx ewoc-goto-next ewoc arg |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4864 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
|
4865 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
|
4866 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
|
4867 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
|
4868 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
|
4869 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4870 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4871 @defun ewoc-goto-node ewoc node |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4872 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
|
4873 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4874 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4875 @defun ewoc-refresh ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4876 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
|
4877 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
|
4878 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
|
4879 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
|
4880 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4881 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4882 @defun ewoc-invalidate ewoc &rest nodes |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4883 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
|
4884 @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
|
4885 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4886 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4887 @defun ewoc-delete ewoc &rest nodes |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4888 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
|
4889 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4890 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4891 @defun ewoc-filter ewoc predicate &rest args |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4892 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
|
4893 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
|
4894 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
|
4895 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4896 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4897 @defun ewoc-collect ewoc predicate &rest args |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4898 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
|
4899 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
|
4900 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
|
4901 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
|
4902 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4903 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4904 @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
|
4905 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
|
4906 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
|
4907 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
|
4908 @end defun |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4909 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4910 @node Abstract Display Example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4911 @subsection Abstract Display Example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4912 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4913 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
|
4914 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
|
4915 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
|
4916 value) in various ways. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4917 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4918 @example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4919 (setq colorcomp-ewoc nil |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4920 colorcomp-data nil |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4921 colorcomp-mode-map nil |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4922 colorcomp-labels ["Red" "Green" "Blue"]) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4923 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4924 (defun colorcomp-pp (data) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4925 (if data |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4926 (let ((comp (aref colorcomp-data data))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4927 (insert (aref colorcomp-labels data) "\t: #x" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4928 (format "%02X" comp) " " |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4929 (make-string (ash comp -2) ?#) "\n")) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4930 (let ((cstr (format "#%02X%02X%02X" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4931 (aref colorcomp-data 0) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4932 (aref colorcomp-data 1) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4933 (aref colorcomp-data 2))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4934 (samp " (sample text) ")) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4935 (insert "Color\t: " |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4936 (propertize samp 'face `(foreground-color . ,cstr)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4937 (propertize samp 'face `(background-color . ,cstr)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4938 "\n")))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4939 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4940 (defun colorcomp (color) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4941 "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
|
4942 The buffer is in Color Components mode." |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4943 (interactive "sColor (name or #RGB or #RRGGBB): ") |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4944 (when (string= "" color) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4945 (setq color "green")) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4946 (unless (color-values color) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4947 (error "No such color: %S" color)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4948 (switch-to-buffer |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4949 (generate-new-buffer (format "originally: %s" color))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4950 (kill-all-local-variables) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4951 (setq major-mode 'colorcomp-mode |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4952 mode-name "Color Components") |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4953 (use-local-map colorcomp-mode-map) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4954 (erase-buffer) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4955 (buffer-disable-undo) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4956 (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
|
4957 (color-values color)))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4958 (ewoc (ewoc-create 'colorcomp-pp |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4959 "\nColor Components\n\n" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4960 (substitute-command-keys |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4961 "\n\\@{colorcomp-mode-map@}")))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4962 (set (make-local-variable 'colorcomp-data) data) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4963 (set (make-local-variable 'colorcomp-ewoc) ewoc) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4964 (ewoc-enter-last ewoc 0) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4965 (ewoc-enter-last ewoc 1) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4966 (ewoc-enter-last ewoc 2) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4967 (ewoc-enter-last ewoc nil))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4968 @end example |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4969 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4970 @cindex controller part, model/view/controller |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4971 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
|
4972 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
|
4973 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
|
4974 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
|
4975 together conveniently. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4976 |
71638 | 4977 @smallexample |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4978 (defun colorcomp-mod (index limit delta) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4979 (let ((cur (aref colorcomp-data index))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4980 (unless (= limit cur) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4981 (aset colorcomp-data index (+ cur delta))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4982 (ewoc-invalidate |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4983 colorcomp-ewoc |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4984 (ewoc-nth colorcomp-ewoc index) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4985 (ewoc-nth colorcomp-ewoc -1)))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4986 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4987 (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
|
4988 (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
|
4989 (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
|
4990 (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
|
4991 (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
|
4992 (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
|
4993 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4994 (defun colorcomp-copy-as-kill-and-exit () |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4995 "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
|
4996 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
|
4997 (interactive) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4998 (kill-new (format "#%02X%02X%02X" |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
4999 (aref colorcomp-data 0) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5000 (aref colorcomp-data 1) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5001 (aref colorcomp-data 2))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5002 (kill-buffer nil)) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5003 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5004 (setq colorcomp-mode-map |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5005 (let ((m (make-sparse-keymap))) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5006 (suppress-keymap m) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5007 (define-key m "i" 'colorcomp-R-less) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5008 (define-key m "o" 'colorcomp-R-more) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5009 (define-key m "k" 'colorcomp-G-less) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5010 (define-key m "l" 'colorcomp-G-more) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5011 (define-key m "," 'colorcomp-B-less) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5012 (define-key m "." 'colorcomp-B-more) |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5013 (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
|
5014 m)) |
71638 | 5015 @end smallexample |
71009
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5016 |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5017 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
|
5018 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
|
5019 @code{colorcomp-data}, the actual color components. |
a2f2de00b286
(Display): Add "Abstract Display" to menu.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
70843
diff
changeset
|
5020 |
6598 | 5021 @node Blinking |
5022 @section Blinking Parentheses | |
5023 @cindex parenthesis matching | |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
5024 @cindex blinking parentheses |
6598 | 5025 @cindex balancing parentheses |
5026 | |
5027 This section describes the mechanism by which Emacs shows a matching | |
5028 open parenthesis when the user inserts a close parenthesis. | |
5029 | |
5030 @defvar blink-paren-function | |
5031 The value of this variable should be a function (of no arguments) to | |
5032 be called whenever a character with close parenthesis syntax is inserted. | |
5033 The value of @code{blink-paren-function} may be @code{nil}, in which | |
5034 case nothing is done. | |
5035 @end defvar | |
5036 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5037 @defopt blink-matching-paren |
6598 | 5038 If this variable is @code{nil}, then @code{blink-matching-open} does |
5039 nothing. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5040 @end defopt |
6598 | 5041 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5042 @defopt blink-matching-paren-distance |
6598 | 5043 This variable specifies the maximum distance to scan for a matching |
5044 parenthesis before giving up. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5045 @end defopt |
6598 | 5046 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5047 @defopt blink-matching-delay |
12098 | 5048 This variable specifies the number of seconds for the cursor to remain |
5049 at the matching parenthesis. A fraction of a second often gives | |
5050 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
|
5051 @end defopt |
12098 | 5052 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5053 @deffn Command blink-matching-open |
6598 | 5054 This function is the default value of @code{blink-paren-function}. It |
5055 assumes that point follows a character with close parenthesis syntax and | |
5056 moves the cursor momentarily to the matching opening character. If that | |
5057 character is not already on the screen, it displays the character's | |
5058 context in the echo area. To avoid long delays, this function does not | |
5059 search farther than @code{blink-matching-paren-distance} characters. | |
5060 | |
5061 Here is an example of calling this function explicitly. | |
5062 | |
5063 @smallexample | |
5064 @group | |
5065 (defun interactive-blink-matching-open () | |
5066 @c Do not break this line! -- rms. | |
5067 @c The first line of a doc string | |
5068 @c must stand alone. | |
5069 "Indicate momentarily the start of sexp before point." | |
5070 (interactive) | |
5071 @end group | |
5072 @group | |
5073 (let ((blink-matching-paren-distance | |
5074 (buffer-size)) | |
5075 (blink-matching-paren t)) | |
5076 (blink-matching-open))) | |
5077 @end group | |
5078 @end smallexample | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5079 @end deffn |
6598 | 5080 |
5081 @node Usual Display | |
5082 @section Usual Display Conventions | |
5083 | |
5084 The usual display conventions define how to display each character | |
5085 code. You can override these conventions by setting up a display table | |
5086 (@pxref{Display Tables}). Here are the usual display conventions: | |
5087 | |
5088 @itemize @bullet | |
5089 @item | |
5090 Character codes 32 through 126 map to glyph codes 32 through 126. | |
5091 Normally this means they display as themselves. | |
5092 | |
5093 @item | |
5094 Character code 9 is a horizontal tab. It displays as whitespace | |
5095 up to a position determined by @code{tab-width}. | |
5096 | |
5097 @item | |
5098 Character code 10 is a newline. | |
5099 | |
5100 @item | |
5101 All other codes in the range 0 through 31, and code 127, display in one | |
9009 | 5102 of two ways according to the value of @code{ctl-arrow}. If it is |
6598 | 5103 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
|
5104 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can |
6598 | 5105 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map |
5106 just like the codes in the range 128 to 255. | |
5107 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5108 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
|
5109 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
|
5110 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
|
5111 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
|
5112 emacs, The GNU Emacs Manual}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5113 |
6598 | 5114 @item |
5115 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
|
5116 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
|
5117 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
|
5118 table can specify a glyph to use instead of @samp{\}.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5119 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5120 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5121 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
|
5122 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
|
5123 character. |
6598 | 5124 @end itemize |
5125 | |
5126 The usual display conventions apply even when there is a display | |
5127 table, for any character whose entry in the active display table is | |
5128 @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
|
5129 specify the characters for which you want special behavior. |
6598 | 5130 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
5131 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
|
5132 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
|
5133 buffer where you expect it, if it was eliminated as part of end-of-line |
25454 | 5134 conversion (@pxref{Coding System Basics}). |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
5135 |
6598 | 5136 These variables affect the way certain characters are displayed on the |
5137 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
|
5138 they also affect the indentation functions. These variables also affect |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5139 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
|
5140 mode line using the new values, call the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5141 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
6598 | 5142 |
5143 @defopt ctl-arrow | |
5144 @cindex control characters in display | |
5145 This buffer-local variable controls how control characters are | |
5146 displayed. If it is non-@code{nil}, they are displayed as a caret | |
5147 followed by the character: @samp{^A}. If it is @code{nil}, they are | |
5148 displayed as a backslash followed by three octal digits: @samp{\001}. | |
5149 @end defopt | |
5150 | |
5151 @c Following may have overfull hbox. | |
5152 @defvar default-ctl-arrow | |
5153 The value of this variable is the default value for @code{ctl-arrow} in | |
5154 buffers that do not override it. @xref{Default Value}. | |
5155 @end defvar | |
5156 | |
58496
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
5157 @defopt tab-width |
65369
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65121
diff
changeset
|
5158 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
|
5159 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
|
5160 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
|
5161 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
|
5162 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
|
5163 @end defopt |
c6040c1274b7
(Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents:
58371
diff
changeset
|
5164 |
6598 | 5165 @node Display Tables |
5166 @section Display Tables | |
5167 | |
5168 @cindex display table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5169 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
|
5170 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
|
5171 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
|
5172 set. |
6598 | 5173 |
5174 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
|
5175 @dfn{glyphs}, each glyph being a graphic that takes up one character |
6598 | 5176 position on the screen. You can also define how to display each glyph |
5177 on your terminal, using the @dfn{glyph table}. | |
5178 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5179 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
|
5180 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
|
5181 @code{force-mode-line-update} (@pxref{Mode Line Format}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5182 |
6598 | 5183 @menu |
53467
a18219fcd84d
Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents:
53422
diff
changeset
|
5184 * 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
|
5185 * 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
|
5186 * Glyphs:: How to define a glyph, and what glyphs mean. |
6598 | 5187 @end menu |
5188 | |
5189 @node Display Table Format | |
5190 @subsection Display Table Format | |
5191 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5192 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
|
5193 @code{display-table} as its subtype. |
6598 | 5194 |
5195 @defun make-display-table | |
5196 This creates and returns a display table. The table initially has | |
5197 @code{nil} in all elements. | |
5198 @end defun | |
5199 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5200 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
|
5201 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
|
5202 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
|
5203 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
|
5204 character @var{c} according to the usual display conventions |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5205 (@pxref{Usual Display}). |
12067 | 5206 |
72820
501a2788cfa4
(Display Table Format): Wording clarification
Richard M. Stallman <rms@gnu.org>
parents:
72789
diff
changeset
|
5207 @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
|
5208 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
|
5209 ``line.'' |
6598 | 5210 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5211 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
|
5212 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
|
5213 means to use the default for that slot, as stated below. |
6598 | 5214 |
5215 @table @asis | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5216 @item 0 |
6598 | 5217 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
|
5218 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
|
5219 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
|
5220 no effect. |
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
5221 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5222 @item 1 |
6598 | 5223 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
|
5224 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
|
5225 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
|
5226 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5227 @item 2 |
6598 | 5228 The glyph for indicating a character displayed as an octal character |
5229 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
|
5230 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5231 @item 3 |
6598 | 5232 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
|
5233 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5234 @item 4 |
6598 | 5235 A vector of glyphs for indicating the presence of invisible lines (the |
5236 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
|
5237 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5238 @item 5 |
8925 | 5239 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
|
5240 default is @samp{|}). @xref{Splitting Windows}. This takes effect only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5241 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
|
5242 a scroll bar separates the two windows. |
6598 | 5243 @end table |
5244 | |
5245 For example, here is how to construct a display table that mimics the | |
5246 effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
5247 | |
5248 @example | |
5249 (setq disptab (make-display-table)) | |
5250 (let ((i 0)) | |
5251 (while (< i 32) | |
5252 (or (= i ?\t) (= i ?\n) | |
5253 (aset disptab i (vector ?^ (+ i 64)))) | |
5254 (setq i (1+ i))) | |
5255 (aset disptab 127 (vector ?^ ??))) | |
5256 @end example | |
5257 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5258 @defun display-table-slot display-table slot |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5259 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
|
5260 @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
|
5261 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5262 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5263 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5264 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5265 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5266 @defun set-display-table-slot display-table slot value |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5267 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
|
5268 @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
|
5269 5 inclusive, or a slot name (symbol). Valid symbols are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5270 @code{truncation}, @code{wrap}, @code{escape}, @code{control}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5271 @code{selective-display}, and @code{vertical-border}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5272 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5273 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5274 @defun describe-display-table display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5275 This function displays a description of the display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5276 @var{display-table} in a help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5277 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5278 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5279 @deffn Command describe-current-display-table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5280 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
|
5281 help buffer. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5282 @end deffn |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5283 |
6598 | 5284 @node Active Display Table |
5285 @subsection Active Display Table | |
5286 @cindex active display table | |
5287 | |
5288 Each window can specify a display table, and so can each buffer. When | |
5289 a buffer @var{b} is displayed in window @var{w}, display uses the | |
5290 display table for window @var{w} if it has one; otherwise, the display | |
5291 table for buffer @var{b} if it has one; otherwise, the standard display | |
5292 table if any. The display table chosen is called the @dfn{active} | |
5293 display table. | |
5294 | |
60503
ed1869261935
(Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents:
60442
diff
changeset
|
5295 @defun window-display-table &optional window |
6598 | 5296 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
|
5297 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
|
5298 for @var{window} is the selected window. |
6598 | 5299 @end defun |
5300 | |
5301 @defun set-window-display-table window table | |
5302 This function sets the display table of @var{window} to @var{table}. | |
5303 The argument @var{table} should be either a display table or | |
5304 @code{nil}. | |
5305 @end defun | |
5306 | |
5307 @defvar buffer-display-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5308 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
|
5309 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
|
5310 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
|
5311 table. |
6598 | 5312 @end defvar |
5313 | |
5314 @defvar standard-display-table | |
5315 This variable's value is the default display table, used whenever a | |
5316 window has no display table and neither does the buffer displayed in | |
5317 that window. This variable is @code{nil} by default. | |
5318 @end defvar | |
5319 | |
5320 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
|
5321 if the window specifies none, its buffer specifies none, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5322 @code{standard-display-table} is @code{nil}---then Emacs uses the usual |
6598 | 5323 display conventions for all character codes in that window. @xref{Usual |
5324 Display}. | |
5325 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5326 A number of functions for changing the standard display table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5327 are defined in the library @file{disp-table}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5328 |
6598 | 5329 @node Glyphs |
5330 @subsection Glyphs | |
5331 | |
5332 @cindex glyph | |
5333 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
|
5334 image that takes up a single character position on the screen. Normally |
75755 | 5335 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
|
5336 |
75875
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5337 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
|
5338 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
|
5339 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
|
5340 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
|
5341 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5342 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
|
5343 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5344 @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
|
5345 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
|
5346 with face @var{face}. |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5347 @end defun |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5348 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5349 @defun glyph-char glyph |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5350 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
|
5351 @end defun |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5352 |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5353 @defun glyph-face glyph |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5354 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
|
5355 @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
|
5356 @end defun |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5357 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5358 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
|
5359 the meaning of glyph codes (represented as small integers). |
6598 | 5360 |
5361 @defvar glyph-table | |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5362 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
|
5363 @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
|
5364 @var{g}. |
47482
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5365 |
aabdbec10b60
Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents:
46721
diff
changeset
|
5366 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
|
5367 table, that code is automatically simple. If @code{glyph-table} is |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5368 @code{nil} then all glyph codes are simple. |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5369 |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5370 The glyph table is used only on character terminals. On graphical |
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5371 displays, all glyph codes are simple. |
6598 | 5372 @end defvar |
5373 | |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5374 Here are the meaningful types of elements in the glyph table: |
6598 | 5375 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5376 @table @asis |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5377 @item @var{string} |
6598 | 5378 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
|
5379 this glyph code. |
6598 | 5380 |
75875
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5381 @item @var{code} |
bdb0a4edf3b9
(Glyphs): Add make-glyph-code, glyph-char, glyph-face.
Kim F. Storm <storm@cua.dk>
parents:
75755
diff
changeset
|
5382 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
|
5383 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
|
5384 small-numbered glyph code which specifies a character with a face. |
6598 | 5385 |
5386 @item @code{nil} | |
72822
f55964fec436
(Glyphs): Clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
72820
diff
changeset
|
5387 This glyph code is simple. |
6598 | 5388 @end table |
5389 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5390 @defun create-glyph string |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5391 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
|
5392 display by sending @var{string} to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5393 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5394 |
6598 | 5395 @node Beeping |
5396 @section Beeping | |
77010
e009ed31b7cf
Improve index entries. Remove redundant ones.
Richard M. Stallman <rms@gnu.org>
parents:
76850
diff
changeset
|
5397 @c @cindex beeping "beep" is adjacent |
6598 | 5398 @cindex bell |
5399 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5400 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
|
5401 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
|
5402 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
|
5403 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
|
5404 appropriate. (@xref{Errors}.) |
6598 | 5405 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5406 @defun ding &optional do-not-terminate |
6598 | 5407 @cindex keyboard macro termination |
5408 This function beeps, or flashes the screen (see @code{visible-bell} below). | |
5409 It also terminates any keyboard macro currently executing unless | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5410 @var{do-not-terminate} is non-@code{nil}. |
6598 | 5411 @end defun |
5412 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5413 @defun beep &optional do-not-terminate |
6598 | 5414 This is a synonym for @code{ding}. |
5415 @end defun | |
5416 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5417 @defopt visible-bell |
6598 | 5418 This variable determines whether Emacs should flash the screen to |
5419 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
|
5420 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
|
5421 provided the terminal's Termcap entry defines the visible bell |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
5422 capability (@samp{vb}). |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5423 @end defopt |
6598 | 5424 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5425 @defvar ring-bell-function |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5426 If this is non-@code{nil}, it specifies how Emacs should ``ring the |
25875 | 5427 bell.'' Its value should be a function of no arguments. If this is |
5428 non-@code{nil}, it takes precedence over the @code{visible-bell} | |
5429 variable. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5430 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5431 |
6598 | 5432 @node Window Systems |
5433 @section Window Systems | |
5434 | |
5435 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
|
5436 System. Both Emacs and X use the term ``window,'' but use it |
6598 | 5437 differently. An Emacs frame is a single window as far as X is |
5438 concerned; the individual Emacs windows are not known to X at all. | |
5439 | |
5440 @defvar window-system | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5441 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
|
5442 under. The possible values are |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5443 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5444 @table @code |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5445 @item x |
6598 | 5446 @cindex X Window System |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5447 Emacs is displaying using X. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5448 @item pc |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5449 Emacs is displaying using MS-DOS. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5450 @item w32 |
27332
5cfe77eaff45
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27331
diff
changeset
|
5451 Emacs is displaying using Windows. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5452 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
5453 Emacs is displaying using a Macintosh. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5454 @item nil |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5455 Emacs is using a character-based terminal. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
5456 @end table |
6598 | 5457 @end defvar |
5458 | |
5459 @defvar window-setup-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
18234
diff
changeset
|
5460 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
|
5461 initialization files. Emacs runs this hook after it has completed |
25875 | 5462 loading your init file, the default initialization file (if |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
5463 any), and the terminal-specific Lisp code, and running the hook |
6598 | 5464 @code{term-setup-hook}. |
5465 | |
5466 This hook is used for internal purposes: setting up communication with | |
5467 the window system, and creating the initial window. Users should not | |
5468 interfere with it. | |
5469 @end defvar | |
52401 | 5470 |
5471 @ignore | |
5472 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6 | |
5473 @end ignore |