annotate lispref/display.texi @ 69907:e711374bee77

(rmail-mime-charset-pattern): Ignore format and delsp specs while looking for charset.
author Richard M. Stallman <rms@gnu.org>
date Mon, 10 Apr 2006 03:19:03 +0000
parents 85e6a1c82a54
children cb9bbccfa10f 65ca8fb66a0d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
64174
e67e083f596d Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 64156
diff changeset
1 @c -*-texinfo-*-
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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,
68648
067115a6e738 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 68459
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Emacs Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 This chapter describes a number of features related to the display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 that Emacs presents to the user.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 @menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
19 * Invisible Text:: Hiding part of the buffer text.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
20 * Selective Display:: Hiding part of the buffer text (the old way).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
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
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
26 font, colors, etc.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
27 * Fringes:: Controlling window fringes.
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
28 * Scroll Bars:: Controlling vertical scroll bars.
57202
ce88ee86e383 *** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents: 57201
diff changeset
29 * Pointer Shape:: Controlling the mouse pointer shape.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
30 * Display Property:: Enabling special display features.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
31 * Images:: Displaying images in Emacs buffers.
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
32 * Buttons:: Adding clickable buttons to Emacs buffers.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 * Beeping:: Audible signal to the user.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 * Window Systems:: Which window system is being used.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 @node Refresh Screen
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 @section Refreshing the Screen
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 @c Emacs 19 feature
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 @defun redraw-frame frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 This function clears and redisplays frame @var{frame}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 @deffn Command redraw-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 This function clears and redisplays all visible frames.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 @end deffn
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
58 This function calls for redisplay of certain windows, the next time
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
59 redisplay is done, but does not clear them first.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
60
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
61 @defun force-window-update &optional object
53422
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
62 This function forces redisplay of some or all windows. If
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
63 @var{object} is a window, it forces redisplay of that window. If
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
64 @var{object} is a buffer or buffer name, it forces redisplay of all
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
65 windows displaying that buffer. If @var{object} is @code{nil} (or
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
66 omitted), it forces redisplay of all windows.
53422
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
67 @end defun
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
68
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
69 Processing user input takes absolute priority over redisplay. If you
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
70 call these functions when input is available, they do nothing
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
71 immediately, but a full redisplay does happen eventually---after all the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
72 input has been processed.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
73
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 Normally, suspending and resuming Emacs also refreshes the screen.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 Some terminal emulators record separate contents for display-oriented
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 programs such as Emacs and for ordinary sequential display. If you are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 using such a terminal, you might want to inhibit the redisplay on
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
78 resumption.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 @defvar no-redraw-on-reenter
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 @cindex suspend (cf. @code{no-redraw-on-reenter})
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 @cindex resume (cf. @code{no-redraw-on-reenter})
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 This variable controls whether Emacs redraws the entire screen after it
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
84 has been suspended and resumed. Non-@code{nil} means there is no need
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
85 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
88 @node Forcing Redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
89 @section Forcing Redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
90 @cindex forcing redisplay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
91
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
92 Emacs redisplay normally stops if input arrives, and does not happen
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
93 at all if input is available before it starts. Most of the time, this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
94 is exactly what you want. However, you can prevent preemption by
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
95 binding @code{redisplay-dont-pause} to a non-@code{nil} value.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
96
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
97 @tindex redisplay-dont-pause
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
98 @defvar redisplay-dont-pause
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
99 If this variable is non-@code{nil}, pending input does not
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
100 prevent or halt redisplay; redisplay occurs, and finishes,
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
101 regardless of whether input is available.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
102 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
103
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
104 You can request a display update, but only if no input is pending,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
105 with @code{(sit-for 0)}. To force a display update even when input is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
106 pending, do this:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
107
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
108 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
109 (let ((redisplay-dont-pause t))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
110 (sit-for 0))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
111 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
112
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 @node Truncation
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 @section Truncation
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 @cindex line wrapping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 @cindex continuation lines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 @cindex @samp{$} in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 @cindex @samp{\} in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 When a line of text extends beyond the right edge of a window, the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 line can either be continued on the next screen line, or truncated to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 one screen line. The additional screen lines used to display a long
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 text line are called @dfn{continuation} lines. Normally, a @samp{$} in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 the rightmost column of the window indicates truncation; a @samp{\} on
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
125 the rightmost column indicates a line that ``wraps'' onto the next line,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
126 which is also called @dfn{continuing} the line. (The display table can
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
127 specify alternative indicators; see @ref{Display Tables}.)
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128
68708
c0833efdd110 "Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents: 68648
diff changeset
129 On a graphical display, the @samp{$} and @samp{\} indicators are
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
130 replaced with arrow images displayed in the window fringes
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
131 (@pxref{Fringes}).
42905
09cd352a779e (Truncation, Overlay Arrow, Usual Display): Add index entries for fringe
Eli Zaretskii <eliz@gnu.org>
parents: 42888
diff changeset
132
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 Note that continuation is different from filling; continuation happens
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 on the screen only, not in the buffer contents, and it breaks a line
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 precisely at the right margin, not at a word boundary. @xref{Filling}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 @defopt truncate-lines
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 This buffer-local variable controls how Emacs displays lines that extend
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 beyond the right edge of the window. The default is @code{nil}, which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 specifies continuation. If the value is non-@code{nil}, then these
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 lines are truncated.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 If the variable @code{truncate-partial-width-windows} is non-@code{nil},
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 then truncation is always used for side-by-side windows (within one
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 frame) regardless of the value of @code{truncate-lines}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
148 @defopt default-truncate-lines
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 This variable is the default value for @code{truncate-lines}, for
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
150 buffers that do not have buffer-local values for it.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
151 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 @defopt truncate-partial-width-windows
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 This variable controls display of lines that extend beyond the right
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155 edge of the window, in side-by-side windows (@pxref{Splitting Windows}).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 If it is non-@code{nil}, these lines are truncated; otherwise,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157 @code{truncate-lines} says what to do with them.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
160 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
161 a window, that forces truncation.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
162
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
163 If your buffer contains @emph{very} long lines, and you use
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
164 continuation to display them, just thinking about them can make Emacs
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
165 redisplay slow. The column computation and indentation functions also
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
166 become slow. Then you might find it advisable to set
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
167 @code{cache-long-line-scans} to @code{t}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
168
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
169 @defvar cache-long-line-scans
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
170 If this variable is non-@code{nil}, various indentation and motion
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
171 functions, and Emacs redisplay, cache the results of scanning the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
172 buffer, and consult the cache to avoid rescanning regions of the buffer
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
173 unless they are modified.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
174
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
175 Turning on the cache slows down processing of short lines somewhat.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
176
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
177 This variable is automatically buffer-local in every buffer.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
178 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
179
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180 @node The Echo Area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 @section The Echo Area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 @cindex error display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 @cindex echo area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184
63957
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
185 The @dfn{echo area} is used for displaying error messages
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
186 (@pxref{Errors}), for messages made with the @code{message} primitive,
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
187 and for echoing keystrokes. It is not the same as the minibuffer,
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
188 despite the fact that the minibuffer appears (when active) in the same
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
189 place on the screen as the echo area. The @cite{GNU Emacs Manual}
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
190 specifies the rules for resolving conflicts between the echo area and
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
191 the minibuffer for use of that screen space (@pxref{Minibuffer,, The
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
192 Minibuffer, emacs, The GNU Emacs Manual}).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193
63957
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
194 You can write output in the echo area by using the Lisp printing
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
195 functions with @code{t} as the stream (@pxref{Output Functions}), or
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
196 explicitly.
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
197
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
198 @menu
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
199 * Displaying Messages:: Explicitly displaying text in the echo area.
63967
bbc8b6b4962d (The Echo Area): Correct menu.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63957
diff changeset
200 * Progress:: Informing user about progress of a long operation.
63957
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
201 * Logging Messages:: Echo area messages are logged for the user.
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
202 * Echo Area Customization:: Controlling the echo area.
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
203 @end menu
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
204
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
205 @node Displaying Messages
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
206 @subsection Displaying Messages in the Echo Area
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
207
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
208 This section describes the functions for explicitly producing echo
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
209 area messages. Many other Emacs features display messages there, too.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210
65740
a0447a0dfab8 (Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents: 65598
diff changeset
211 @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
212 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
213 @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
214 string. See @code{format} in @ref{Formatting Strings}, for the details
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 on the conversion specifications. @code{message} returns the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 constructed string.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217
7735
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
218 In batch mode, @code{message} prints the message text on the standard
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
219 error stream, followed by a newline.
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
220
65740
a0447a0dfab8 (Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents: 65598
diff changeset
221 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
222 @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
223
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 @c Emacs 19 feature
65740
a0447a0dfab8 (Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents: 65598
diff changeset
225 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
226 @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
227 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
228 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
229 onto the screen immediately.
7735
7db892210924 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7086
diff changeset
230
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 (message "Minibuffer depth is %d."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 (minibuffer-depth))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235 @print{} Minibuffer depth is 0.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236 @result{} "Minibuffer depth is 0."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 Minibuffer depth is 0.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 @end example
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
245
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
246 To automatically display a message in the echo area or in a pop-buffer,
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
247 depending on its size, use @code{display-message-or-buffer} (see below).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
250 @tindex with-temp-message
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
251 @defmac with-temp-message message &rest body
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
252 This construct displays a message in the echo area temporarily, during
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
253 the execution of @var{body}. It displays @var{message}, executes
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
254 @var{body}, then returns the value of the last body form while restoring
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
255 the previous echo area contents.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
256 @end defmac
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
257
65740
a0447a0dfab8 (Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents: 65598
diff changeset
258 @defun message-or-box format-string &rest arguments
22843
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
259 This function displays a message like @code{message}, but may display it
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
260 in a dialog box instead of the echo area. If this function is called in
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
261 a command that was invoked using the mouse---more precisely, if
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
262 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
263 @code{nil} or a list---then it uses a dialog box or pop-up menu to
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
264 display the message. Otherwise, it uses the echo area. (This is the
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
265 same criterion that @code{y-or-n-p} uses to make a similar decision; see
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
266 @ref{Yes-or-No Queries}.)
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
267
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
268 You can force use of the mouse or of the echo area by binding
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
269 @code{last-nonmenu-event} to a suitable value around the call.
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
270 @end defun
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
271
65740
a0447a0dfab8 (Displaying Messages): Rename argument name `string' to `format-string'
Juri Linkov <juri@jurta.org>
parents: 65598
diff changeset
272 @defun message-box format-string &rest arguments
22843
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
273 This function displays a message like @code{message}, but uses a dialog
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
274 box (or a pop-up menu) whenever that is possible. If it is impossible
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
275 to use a dialog box or pop-up menu, because the terminal does not
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
276 support them, then @code{message-box} uses the echo area, like
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
277 @code{message}.
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
278 @end defun
63f6e25f0cbd *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
279
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
280 @defun display-message-or-buffer message &optional buffer-name not-this-window frame
32840
07d490290ba8 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 32802
diff changeset
281 @tindex display-message-or-buffer
32261
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
282 This function displays the message @var{message}, which may be either a
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
283 string or a buffer. If it is shorter than the maximum height of the
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
284 echo area, as defined by @code{max-mini-window-height}, it is displayed
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
285 in the echo area, using @code{message}. Otherwise,
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
286 @code{display-buffer} is used to show it in a pop-up buffer.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
287
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
288 Returns either the string shown in the echo area, or when a pop-up
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
289 buffer is used, the window used to display it.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
290
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
291 If @var{message} is a string, then the optional argument
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
292 @var{buffer-name} is the name of the buffer used to display it when a
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
293 pop-up buffer is used, defaulting to @samp{*Message*}. In the case
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
294 where @var{message} is a string and displayed in the echo area, it is
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
295 not specified whether the contents are inserted into the buffer anyway.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
296
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
297 The optional arguments @var{not-this-window} and @var{frame} are as for
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
298 @code{display-buffer}, and only used if a buffer is displayed.
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
299 @end defun
c354d0540694 Document `display-message-or-buffer'.
Miles Bader <miles@gnu.org>
parents: 32089
diff changeset
300
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
301 @defun current-message
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
302 This function returns the message currently being displayed in the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
303 echo area, or @code{nil} if there is none.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
304 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
305
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
306 @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
307 @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
308 @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
309
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
310 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
311 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
312 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
313
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
314 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
315 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
316 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
317
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
318 @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
319 (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
320 (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
321 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
322 (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
323 (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
324 (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
325 (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
326 @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
327
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
328 @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
329 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
330 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
331 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
332 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
333
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
334 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
335 @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
336 @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
337 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
338 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
339
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 @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
341 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
342 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
343 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
344 @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
345 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
346 @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
347 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
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 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
350 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
351 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
352 @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
353 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
354 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
355 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
356 @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
357 (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
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 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
360 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
361 @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
362
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 @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
364 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
365 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
366 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
367 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
368 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
369
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 @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
371 @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
372 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
373 @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
374 @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
375 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
376
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
377 This function 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
378 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
379 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
380 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
381 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
382 @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
383
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 @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
385 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
386 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
387
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 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
389 @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
390 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
391 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
392 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
393 @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
394
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 @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
396 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
397 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
398 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
399
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 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
401 @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
402 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
403 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
404 @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
405
66143
a055e5294831 (Progress, Defining Faces):
Juri Linkov <juri@jurta.org>
parents: 65799
diff changeset
406 @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
407 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
408 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
409 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
410
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 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
412 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
413
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 @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
415 (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
416 (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
417 "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
418 (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
419 @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
420 @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
421
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 @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
423 @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
424 @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
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 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
427 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
428 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
429 @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
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 @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
432 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
433 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
434 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
435 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
436
8bd575c72fe0 (Displaying Messages): New node, with most of what was in The Echo Area.
Richard M. Stallman <rms@gnu.org>
parents: 63782
diff changeset
437 @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
438 (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
439 (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
440 @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
441 @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
442
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 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
444 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
445 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
446 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
447
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 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
449 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
450 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
451 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
452 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
453
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 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
455 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
456 @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
457 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
458 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
459
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 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
461 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
462 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
463 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
464
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 @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
466 @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
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 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
469
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
470 @defvar cursor-in-echo-area
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
471 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
472 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
473 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
474 point---not in the echo area at all.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
475
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
476 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
477 for brief periods of time.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
478 @end defvar
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
479
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
480 @defvar echo-area-clear-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
481 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
482 @code{(message nil)} or for any other reason.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
483 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
484
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
485 @defvar echo-keystrokes
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
486 This variable determines how much time should elapse before command
27971
b10a9716fb38 echo-keystrokes change.
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
487 characters echo. Its value must be an integer or floating point number,
b10a9716fb38 echo-keystrokes change.
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
488 which specifies the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
489 number of seconds to wait before echoing. If the user types a prefix
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
490 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
491 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
492 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
493 sequence are echoed immediately.)
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
494
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
495 If the value is zero, then command input is not echoed.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
496 @end defvar
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
497
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
498 @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
499 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
500 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
501 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
502 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
503 @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
504
64841
c171f553d289 (Echo Area Customization): Don't define max-mini-window-height here;
Richard M. Stallman <rms@gnu.org>
parents: 64411
diff changeset
505 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
506 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
507 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
508 @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
509
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
510 @node Warnings
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
511 @section Reporting Warnings
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
512 @cindex warnings
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
513
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
514 @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
515 possible problem, but continue running.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
516
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
517 @menu
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
518 * 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
519 * 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
520 * 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
521 @end menu
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
522
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
523 @node Warning Basics
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
524 @subsection Warning Basics
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
525 @cindex severity level
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
526
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
527 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
528 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
529 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
530 meanings:
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
531
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
532 @table @code
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
533 @item :emergency
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
534 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
535 if you do not attend to it promptly.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
536 @item :error
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
537 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
538 @item :warning
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
539 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
540 raise suspicion of a possible problem.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
541 @item :debug
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
542 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
543 @end table
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 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
546 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
547 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
548 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
549 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
550 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
551 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
552 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
553 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
554 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
555 @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
556 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
557
52156
198af82c7606 (Warning Basics): Fix typo.
John Paul Wallington <jpw@pobox.com>
parents: 52141
diff changeset
558 @cindex warning type
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
559 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
560 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
561 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
562 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
563 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
564 list.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
565
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
566 @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
567 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
568 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
569 severity level, with @code{:warning} being the default.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
570
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
571 @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
572 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
573 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
574
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
575 @defun lwarn type level message &rest args
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
576 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
577 @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
578 equivalent to @code{display-warning}.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
579 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
580
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
581 @defun warn message &rest args
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
582 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
583 @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
584 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
585 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
586 specify a specific warning type.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
587 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
588
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
589 @node Warning Variables
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
590 @subsection Warning Variables
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
591
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
592 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
593 the variables described in this section.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
594
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
595 @defvar warning-levels
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
596 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
597 severity levels. Each element defines one severity level,
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
598 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
599
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
600 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
601 @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
602 @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
603 @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
604 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
605 that information.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
606
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
607 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
608 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
609
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
610 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
611 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
612
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
613 @defvar warning-prefix-function
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
614 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
615 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
616 @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
617 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
618 the beginning of the warning message.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
619
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
620 The 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
621 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
622 entry (this value need not be an actual member of
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
623 @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
624 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
625 a given severity level.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
626
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
627 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
628 to call.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
629 @end defvar
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 @defvar warning-series
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
632 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
633 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
634 that means to leave point on the first warning of the series, rather
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
635 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
636 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
637 @code{warning-series} becomes @code{nil} again.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
638
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
639 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
640 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
641 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
642 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
643 of warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
644
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
645 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
646 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
647
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
648 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
649 each warning separately.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
650 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
651
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
652 @defvar warning-fill-prefix
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
653 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
654 use for filling each warning's text.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
655 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
656
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
657 @defvar warning-type-format
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
658 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
659 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
660 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
661 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
662 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
663 all.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
664 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
665
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
666 @node Warning Options
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
667 @subsection Warning Options
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
668
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
669 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
670 when a Lisp program reports a warning.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
671
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
672 @defopt warning-minimum-level
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
673 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
674 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
675 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
676 warnings.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
677 @end defopt
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 @defopt warning-minimum-log-level
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
680 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
681 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
682 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
683 @end defopt
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
684
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
685 @defopt warning-suppress-types
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
686 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
687 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
688 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
689 type, then that warning is not displayed immediately.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
690 @end defopt
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
691
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
692 @defopt warning-suppress-log-types
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
693 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
694 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
695 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
696 that warning is not logged.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
697 @end defopt
53422
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
698
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
699 @node Invisible Text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
700 @section Invisible Text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
701
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
702 @cindex invisible text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
703 You can make characters @dfn{invisible}, so that they do not appear on
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
704 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
705 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
706 (@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
707 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
708 point to the other side of them.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
709
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
710 In the simplest case, any non-@code{nil} @code{invisible} property makes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
711 a character invisible. This is the default case---if you don't alter
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
712 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
713 @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
714 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
715 to set @code{buffer-invisibility-spec} yourself.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
716
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
717 More generally, you can use the variable @code{buffer-invisibility-spec}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
718 to control which values of the @code{invisible} property make text
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
719 invisible. This permits you to classify the text into different subsets
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
720 in advance, by giving them different @code{invisible} values, and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
721 subsequently make various subsets visible or invisible by changing the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
722 value of @code{buffer-invisibility-spec}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
723
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
724 Controlling visibility with @code{buffer-invisibility-spec} is
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
725 especially useful in a program to display the list of entries in a
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
726 database. It permits the implementation of convenient filtering
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
727 commands to view just a part of the entries in the database. Setting
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
728 this variable is very fast, much faster than scanning all the text in
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
729 the buffer looking for properties to change.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
730
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
731 @defvar buffer-invisibility-spec
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
732 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
733 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
734 buffer-local.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
735
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
736 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
737 @item @code{t}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
738 A character is invisible if its @code{invisible} property is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
739 non-@code{nil}. This is the default.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
740
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
741 @item a list
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
742 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
743 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
744 the character is invisible. The list can have two kinds of elements:
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
745
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
746 @table @code
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
747 @item @var{atom}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
748 A character is invisible if its @code{invisible} property value
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
749 is @var{atom} or if it is a list with @var{atom} as a member.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
750
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
751 @item (@var{atom} . t)
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
752 A character is invisible if its @code{invisible} property value
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
753 is @var{atom} or if it is a list with @var{atom} as a member.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
754 Moreover, if this character is at the end of a line and is followed
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
755 by a visible newline, it displays an ellipsis.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
756 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
757 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
758 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
759
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
760 Two functions are specifically provided for adding elements to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
761 @code{buffer-invisibility-spec} and removing elements from it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
762
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
763 @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
764 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
765 @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
766 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
767 @code{invisible} property is @code{t} remains invisible.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
768 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
769
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
770 @defun remove-from-invisibility-spec element
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
771 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
772 @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
773 is not in the list.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
774 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
775
48948
4dfb36c387bf Explain about conventioal use of t as `invisible' property
Richard M. Stallman <rms@gnu.org>
parents: 48701
diff changeset
776 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
777 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
778 @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
779 @code{invisible} property:
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
780
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
781 @example
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
782 ;; @r{If you want to display an ellipsis:}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
783 (add-to-invisibility-spec '(my-symbol . t))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
784 ;; @r{If you don't want ellipsis:}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
785 (add-to-invisibility-spec 'my-symbol)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
786
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
787 (overlay-put (make-overlay beginning end)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
788 'invisible 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
789
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
790 ;; @r{When done with the overlays:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
791 (remove-from-invisibility-spec '(my-symbol . t))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
792 ;; @r{Or respectively:}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
793 (remove-from-invisibility-spec 'my-symbol)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
794 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
795
15761
77d451c08a30 Document line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 15074
diff changeset
796 @vindex line-move-ignore-invisible
53422
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
797 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
798 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
799 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
800 @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
801 only because they are explicitly programmed to do so.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
802
69462
831f4f793f95 (Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents: 69421
diff changeset
803 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
804 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
805 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
806 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
807 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
808 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
809 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
810 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
811 text.
53422
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
812
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
813 Incremental search can make invisible overlays visible temporarily
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
814 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
815 this, the overlay should have a non-@code{nil}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
816 @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
817 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
818 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
819 overlaps the overlay on exit from the search.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
820
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
821 During the search, such overlays are made temporarily visible by
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
822 temporarily modifying their invisible and intangible properties. If you
22267
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
823 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
824 @code{isearch-open-invisible-temporary} property which is a function.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
825 The function is called with two arguments: the first is the overlay, and
26986
491102e8acc4 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 26698
diff changeset
826 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
827 make it invisible again.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
828
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829 @node Selective Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 @section Selective Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831 @cindex selective display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
833 @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
834 hiding certain lines on the screen.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
836 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
837 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
838 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
839 @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
840 features are different and do not work the same way.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
841
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
842 In the second variant, the choice of lines to hide is made
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
843 automatically based on indentation. This variant is designed to be a
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
844 user-level feature.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846 The way you control explicit selective display is by replacing a
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
847 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
848 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
849 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
850 newlines can separate lines; it is now part of the previous line.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 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
853 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
854 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
855 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
856 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
857 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
858 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
859 parts of the text are hidden.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861 When you write a selectively displayed buffer into a file, all the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
862 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
863 in the file, it looks OK, with nothing hidden. The selective display
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
864 effect is seen only within Emacs.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
865
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866 @defvar selective-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867 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
868 lines, or portions of lines, may be made hidden.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
869
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
870 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
871 @item
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
872 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
873 control-m marks the start of hidden text; the control-m, and the rest
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
874 of the line following it, are not displayed. This is explicit selective
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
875 display.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
876
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
877 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
878 If the value of @code{selective-display} is a positive integer, then
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879 lines that start with more than that many columns of indentation are not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880 displayed.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
881 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
883 When some portion of a buffer is hidden, the vertical movement
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 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
885 @code{next-line} command to skip any number of hidden lines.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
886 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
887 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
888 or delete text in an hidden portion.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890 In the examples below, we show the @emph{display appearance} of the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891 buffer @code{foo}, which changes with the value of
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892 @code{selective-display}. The @emph{contents} of the buffer do not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893 change.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897 (setq selective-display nil)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
898 @result{} nil
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
899
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
900 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 3n this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904 3n this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
908 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 (setq selective-display 2)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912 @result{} 2
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
914 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
915 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
916 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
918 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
921 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
924 @defvar selective-display-ellipses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
925 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
926 @samp{@dots{}} at the end of a line that is followed by hidden text.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
927 This example is a continuation of the previous one.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
928
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
929 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
930 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
931 (setq selective-display-ellipses t)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
932 @result{} t
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
933
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
936 2on this column ...
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
937 2on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 1 on this column
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
939 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
940 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
941 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
942
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
943 You can use a display table to substitute other text for the ellipsis
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
944 (@samp{@dots{}}). @xref{Display Tables}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
945 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
946
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
947 @node Temporary Displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
948 @section Temporary Displays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
950 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
951 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
952 editing. Many help commands use this feature.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 @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
955 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
956 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
957 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
958 displayed in some window, but not selected.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
959
52923
41c0ac1a4ed4 (Temporary Displays): Add xref to `Documentation Tips'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52903
diff changeset
960 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
961 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
962 @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
963 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
964 into clickable cross-references. @xref{Docstring hyperlinks, , Tips
67874c814e45 *** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents: 52978
diff changeset
965 for Documentation Strings}, in particular the item on hyperlinks in
67874c814e45 *** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents: 52978
diff changeset
966 documentation strings, for more details.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
967
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
968 The string @var{buffer-name} specifies the temporary buffer, which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
969 need not already exist. The argument must be a string, not a buffer.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
970 The buffer is erased initially (with no questions asked), and it is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
971 marked as unmodified after @code{with-output-to-temp-buffer} exits.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
972
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
973 @code{with-output-to-temp-buffer} binds @code{standard-output} to the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
974 temporary buffer, then it evaluates the forms in @var{forms}. Output
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
975 using the Lisp output functions within @var{forms} goes by default to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
976 that buffer (but screen display and messages in the echo area, although
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977 they are ``output'' in the general sense of the word, are not affected).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
978 @xref{Output Functions}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
979
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
980 Several hooks are available for customizing the behavior
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
981 of this construct; they are listed below.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
982
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
983 The value of the last form in @var{forms} is returned.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
984
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
985 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
986 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
987 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
988 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
989 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
990 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
991
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
993 (with-output-to-temp-buffer "foo"
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
994 (print 20)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
995 (print standard-output))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
996 @result{} #<buffer foo>
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
997
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
998 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
999 20
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001 #<buffer foo>
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1003 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1004 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 @end defspec
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008 @defvar temp-buffer-show-function
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
1009 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1010 calls it as a function to do the job of displaying a help buffer. The
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1011 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
1012
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1013 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
1014 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
1015 @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
1016 selected.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1017 @end defvar
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1018
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
1019 @defvar temp-buffer-setup-hook
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
1020 @tindex temp-buffer-setup-hook
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
1021 This normal hook is run by @code{with-output-to-temp-buffer} before
42082
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1022 evaluating @var{body}. When the hook runs, the temporary buffer is
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1023 current. This hook is normally set up with a function to put the
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1024 buffer in Help mode.
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
1025 @end defvar
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
1026
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1027 @defvar temp-buffer-show-hook
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1028 This normal hook is run by @code{with-output-to-temp-buffer} after
42082
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1029 displaying the temporary buffer. When the hook runs, the temporary buffer
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1030 is current, and the window it was displayed in is selected. This hook
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1031 is normally set up with a function to make the buffer read only, and
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1032 find function names and variable names in it, provided the major mode
20c1f73d3db3 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 41058
diff changeset
1033 is Help mode.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1034 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1035
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1036 @defun momentary-string-display string position &optional char message
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1037 This function momentarily displays @var{string} in the current buffer at
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1038 @var{position}. It has no effect on the undo list or on the buffer's
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1039 modification status.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1040
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1041 The momentary display remains until the next input event. If the next
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1042 input event is @var{char}, @code{momentary-string-display} ignores it
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1043 and returns. Otherwise, that event remains buffered for subsequent use
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1044 as input. Thus, typing @var{char} will simply remove the string from
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1045 the display, while typing (say) @kbd{C-f} will remove the string from
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1046 the display and later (presumably) move point forward. The argument
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1047 @var{char} is a space by default.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1048
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1049 The return value of @code{momentary-string-display} is not meaningful.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1050
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1051 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
1052 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
1053 deleting) an overlay with a @code{before-string} property.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1054 @xref{Overlay Properties}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1055
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1056 If @var{message} is non-@code{nil}, it is displayed in the echo area
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1057 while @var{string} is displayed in the buffer. If it is @code{nil}, a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1058 default message says to type @var{char} to continue.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1059
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1060 In this example, point is initially located at the beginning of the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1061 second line:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1062
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1063 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1064 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1065 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1066 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1067 @point{}Second line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1068 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1069 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1070
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1071 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1072 (momentary-string-display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1073 "**** Important Message! ****"
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1074 (point) ?\r
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1075 "Type RET when done reading")
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1076 @result{} t
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1077 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1079 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1080 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1081 This is the contents of foo.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1082 **** Important Message! ****Second line.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1083 ---------- Buffer: foo ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1084
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1085 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1086 Type RET when done reading
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1087 ---------- Echo Area ----------
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1088 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1089 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1090 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1091
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1092 @node Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1093 @section Overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1094 @cindex overlays
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1095
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1096 You can use @dfn{overlays} to alter the appearance of a buffer's text on
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1097 the screen, for the sake of presentation features. An overlay is an
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1098 object that belongs to a particular buffer, and has a specified
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1099 beginning and end. It also has properties that you can examine and set;
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1100 these affect the display of the text within the overlay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1101
68084
9b969687ff7c Fix typos.
Eli Zaretskii <eliz@gnu.org>
parents: 67047
diff changeset
1102 An overlay uses markers to record its beginning and end; thus,
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
1103 editing the text of the buffer adjusts the beginning and end of each
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
1104 overlay so that it stays with the text. When you create the overlay,
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
1105 you can specify whether text inserted at the beginning should be
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
1106 inside the overlay or outside, and likewise for the end of the overlay.
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
1107
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1108 @menu
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1109 * 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
1110 * Overlay Properties:: How to read and set properties.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1111 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
1112 * Finding Overlays:: Searching for overlays.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1113 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1114
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1115 @node Managing Overlays
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1116 @subsection Managing Overlays
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1117
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1118 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
1119 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
1120 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
1121 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
1122
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1123 @defun overlayp object
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1124 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
1125 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1126
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1127 @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
1128 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
1129 @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
1130 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
1131 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
1132 current buffer.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1133
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1134 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
1135 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
1136 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
1137 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
1138 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
1139 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
1140 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
1141 @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
1142 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
1143 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1144
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1145 @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
1146 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
1147 as an integer.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1148 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1149
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1150 @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
1151 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
1152 as an integer.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1153 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1154
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1155 @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
1156 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
1157 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
1158 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1159
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1160 @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
1161 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
1162 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
1163 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
1164 display.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1165
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1166 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
1167 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
1168 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1169
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1170 @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
1171 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
1172 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
1173 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
1174
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1175 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
1176 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
1177 the current buffer.
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 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
1180
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1181 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
1182 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
1183 update other vital data structures and can cause some overlays to be
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1184 ``lost''.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1185 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1186
60782
ab5e3944cf27 (Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 60676
diff changeset
1187 @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
1188 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
1189 @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
1190 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
1191
61980
f3d536670495 Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61972
diff changeset
1192 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
1193 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
1194 @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
1195 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
1196 current buffer.
ab5e3944cf27 (Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 60676
diff changeset
1197 @end defun
ab5e3944cf27 (Invisible Text): State default value of line-move-ignore-invisible.
Richard M. Stallman <rms@gnu.org>
parents: 60676
diff changeset
1198
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1199 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
1200
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1201 @example
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1202 ;; @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
1203 (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
1204 @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
1205 (overlay-start foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1206 @result{} 1
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1207 (overlay-end foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1208 @result{} 10
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1209 (overlay-buffer foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1210 @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
1211 ;; @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
1212 (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
1213 @result{} t
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1214 ;; @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
1215 (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
1216 @result{} t
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1217 ;; @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
1218 (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
1219 @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
1220 (overlay-start foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1221 @result{} 5
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1222 (overlay-end foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1223 @result{} 20
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1224 ;; @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
1225 (delete-overlay foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1226 @result{} nil
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1227 ;; @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
1228 foo
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1229 @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
1230 ;; @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
1231 (overlay-start foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1232 @result{} nil
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1233 (overlay-end foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1234 @result{} nil
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1235 (overlay-buffer foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1236 @result{} nil
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1237 ;; @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
1238 (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
1239 @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
1240 ;; @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
1241 (overlay-start foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1242 @result{} 1
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1243 (overlay-end foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1244 @result{} 20
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1245 (overlay-buffer foo)
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1246 @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
1247 ;; @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
1248 (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
1249 @result{} t
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1250 @end example
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1251
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1252 @node Overlay Properties
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1253 @subsection Overlay Properties
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1254
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1255 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
1256 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
1257 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
1258
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1259 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
1260 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
1261 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
1262 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
1263 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
1264 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
1265 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
1266 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
1267
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1268 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
1269
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1270 @defun overlay-get overlay prop
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1271 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
1272 @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
1273 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
1274 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
1275 is @code{nil}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1276 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1277
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1278 @defun overlay-put overlay prop value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1279 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
1280 @var{overlay} to @var{value}. It returns @var{value}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1281 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1282
53422
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
1283 @defun overlay-properties overlay
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
1284 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
1285 @end defun
1246d68686ac (Refresh Screen): Add force-window-update.
Richard M. Stallman <rms@gnu.org>
parents: 53308
diff changeset
1286
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1287 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
1288 overlay properties and text properties for a given character.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1289 @xref{Examining Properties}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1290
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1291 Many overlay properties have special meanings; here is a table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1292 of them:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1293
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 @table @code
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295 @item priority
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1296 @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
1297 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
1298 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
1299 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
1300 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
1301 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
1302 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
1303 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
1304 @code{face} property.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1305
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1306 Currently, all overlays take priority over text properties. Please
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1307 avoid using negative priority values, as we have not yet decided just
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1308 what they should mean.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1309
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1310 @item window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1311 @kindex window @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1312 If the @code{window} property is non-@code{nil}, then the overlay
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1313 applies only on that window.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1314
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1315 @item category
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1316 @kindex category @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1317 If an overlay has a @code{category} property, we call it the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1318 @dfn{category} of the overlay. It should be a symbol. The properties
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1319 of the symbol serve as defaults for the properties of the overlay.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1320
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1321 @item face
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1322 @kindex face @r{(overlay property)}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1323 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
1324 font and which colors. @xref{Faces}, for more information.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1325
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1326 In the simplest case, the value is a face name. It can also be a list;
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1327 then each element can be any of these possibilities:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1328
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1329 @itemize @bullet
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1330 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1331 A face name (a symbol or string).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1332
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1333 @item
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
1334 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
1335 @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
1336 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
1337 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
1338 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
1339 Attributes}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1340
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1341 @item
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1342 A cons cell of the form @code{(foreground-color . @var{color-name})} or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1343 @code{(background-color . @var{color-name})}. These elements specify
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1344 just the foreground color or just the background color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1345
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
1346 @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
1347 @code{(:foreground @var{color-name})}; likewise for the background.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1348 @end itemize
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1349
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1350 @item mouse-face
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1351 @kindex mouse-face @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1352 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
1353 the range of the overlay.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1354
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1355 @item display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1356 @kindex display @r{(overlay property)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1357 This property activates various features that change the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1358 way text is displayed. For example, it can make text appear taller
38278
9e543d761717 Fix several typos.
Gerd Moellmann <gerd@gnu.org>
parents: 37949
diff changeset
1359 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
1360 @xref{Display Property}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1361
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1362 @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
1363 @kindex help-echo @r{(overlay property)}
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
1364 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
1365 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
1366 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
1367 help-echo}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1368
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1369 @item modification-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1370 @kindex modification-hooks @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1371 This property's value is a list of functions to be called if any
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1372 character within the overlay is changed or if text is inserted strictly
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1373 within the overlay.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1374
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1375 The hook functions are called both before and after each change.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1376 If the functions save the information they receive, and compare notes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1377 between calls, they can determine exactly what change has been made
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1378 in the buffer text.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1379
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1380 When called before a change, each function receives four arguments: the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1381 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
1382 modified.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1383
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1384 When called after a change, each function receives five arguments: the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1385 overlay, @code{t}, the beginning and end of the text range just
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1386 modified, and the length of the pre-change text replaced by that range.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1387 (For an insertion, the pre-change length is zero; for a deletion, that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1388 length is the number of characters deleted, and the post-change
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1389 beginning and end are equal.)
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1390
64156
06f333c0aec7 (Inverse Video): Delete mode-line-inverse-video.
Richard M. Stallman <rms@gnu.org>
parents: 63967
diff changeset
1391 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
1392 @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
1393 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
1394
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1395 @item insert-in-front-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1396 @kindex insert-in-front-hooks @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1397 This property's value is a list of functions to be called before and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1398 after inserting text right at the beginning of the overlay. The calling
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1399 conventions are the same as for the @code{modification-hooks} functions.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1400
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1401 @item insert-behind-hooks
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1402 @kindex insert-behind-hooks @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1403 This property's value is a list of functions to be called before and
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1404 after inserting text right at the end of the overlay. The calling
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1405 conventions are the same as for the @code{modification-hooks} functions.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1406
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1407 @item invisible
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1408 @kindex invisible @r{(overlay property)}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1409 The @code{invisible} property can make the text in the overlay
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1410 invisible, which means that it does not appear on the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1411 @xref{Invisible Text}, for details.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1412
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1413 @item intangible
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1414 @kindex intangible @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1415 The @code{intangible} property on an overlay works just like the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1416 @code{intangible} text property. @xref{Special Properties}, for details.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1417
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1418 @item isearch-open-invisible
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1419 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
1420 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
1421 Text}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1423 @item isearch-open-invisible-temporary
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1424 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
1425 visible, temporarily, during the search. @xref{Invisible Text}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1426
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1427 @item before-string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1428 @kindex before-string @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429 This property's value is a string to add to the display at the beginning
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1430 of the overlay. The string does not appear in the buffer in any
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1431 sense---only on the screen.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1432
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1433 @item after-string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1434 @kindex after-string @r{(overlay property)}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1435 This property's value is a string to add to the display at the end of
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1436 the overlay. The string does not appear in the buffer in any
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1437 sense---only on the screen.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1438
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1439 @item evaporate
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1440 @kindex evaporate @r{(overlay property)}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1441 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
1442 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
1443 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
1444 it immediately.
16123
ec5f48fe0320 Mention local-value property on an overlay.
Richard M. Stallman <rms@gnu.org>
parents: 15761
diff changeset
1445
29102
ba9cfbfc601e *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29076
diff changeset
1446 @item local-map
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1447 @cindex keymap of character (and overlays)
29102
ba9cfbfc601e *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29076
diff changeset
1448 @kindex local-map @r{(overlay property)}
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1449 If this property is non-@code{nil}, it specifies a keymap for a portion
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1450 of the text. The property's value replaces the buffer's local map, when
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1451 the character after point is within the overlay. @xref{Active Keymaps}.
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1452
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1453 @item keymap
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1454 @kindex keymap @r{(overlay property)}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1455 The @code{keymap} property is similar to @code{local-map} but overrides the
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1456 buffer's local map (and the map specified by the @code{local-map}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
1457 property) rather than replacing it.
29076
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1458 @end table
c7c150b377c0 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28792
diff changeset
1459
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1460 @node Finding Overlays
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1461 @subsection Searching for Overlays
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1462
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1463 @defun overlays-at pos
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1464 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
1465 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
1466 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
1467 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
1468
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1469 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
1470 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
1471
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1472 @smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1473 (defun find-overlays-specifying (prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1474 (let ((overlays (overlays-at (point)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1475 found)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1476 (while overlays
37170
29f2615d958f (Finding Overlays): Fix example code.
Gerd Moellmann <gerd@gnu.org>
parents: 36935
diff changeset
1477 (let ((overlay (car overlays)))
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1478 (if (overlay-get overlay prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1479 (setq found (cons overlay found))))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1480 (setq overlays (cdr overlays)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1481 found))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1482 @end smallexample
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1483 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1484
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1485 @defun overlays-in beg end
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1486 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
1487 @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
1488 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
1489 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
1490 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
1491 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1492
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1493 @defun next-overlay-change pos
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1494 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
1495 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
1496 @code{(point-max)}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1497 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1498
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1499 @defun previous-overlay-change pos
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1500 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
1501 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
1502 @code{(point-min)}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1503 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1504
65121
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1505 Here's a function which uses @code{next-overlay-change} to search
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1506 for the next character which gets a given property @code{prop} from
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1507 either its overlays or its text properties (@pxref{Property Search}):
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1508
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1509 @smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1510 (defun find-overlay-prop (prop)
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1511 (save-excursion
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1512 (while (and (not (eobp))
65121
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1513 (not (get-char-property (point) prop)))
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1514 (goto-char (min (next-overlay-change (point))
65121
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1515 (next-single-property-change (point) prop))))
26696
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1516 (point)))
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1517 @end smallexample
ef5e7bbe6f19 Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents: 26400
diff changeset
1518
65121
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1519 Now you can search for a @code{happy} property like this:
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1520
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1521 @smallexample
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1522 (find-overlay-prop 'happy)
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1523 @end smallexample
64ac61f4b3b4 (Finding Overlays): Fix `find-overlay-prop' in `next-overlay-change' example.
Richard M. Stallman <rms@gnu.org>
parents: 65075
diff changeset
1524
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1525 @node Width
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1526 @section Width
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1527
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1528 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
1529 check the width of a character. @xref{Primitive Indent}, and
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1530 @ref{Screen Lines}, for related functions.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1531
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1532 @defun char-width char
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1533 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
1534 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
1535 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1536
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1537 @defun string-width string
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1538 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
1539 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
1540 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1541
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1542 @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
1543 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
1544 @var{width} columns, as a new string.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1545
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1546 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
1547 @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
1548 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
1549 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
1550 go beyond it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1551
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1552 The optional argument @var{start-column} specifies the starting column.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1553 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
1554 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
1555 @var{string} extends across the column @var{start-column}, that
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1556 character is not included.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1557
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1558 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
1559 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
1560 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
1561 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
1562 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
1563 @var{string} extends across the column @var{start-column}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1564
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1565 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
1566 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
1567 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
1568 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
1569 @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
1570 @code{"..."}.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
1571
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1572 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1573 (truncate-string-to-width "\tab\t" 12 4)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1574 @result{} "ab"
52002
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
1575 (truncate-string-to-width "\tab\t" 12 4 ?\s)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1576 @result{} " ab "
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1577 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1578 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
1579
58883
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1580 @node Line Height
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1581 @section Line Height
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1582 @cindex line height
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1583
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1584 The total height of each display line consists of the height of the
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1585 contents of the line, and additional vertical line spacing below the
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1586 display row.
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1587
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1588 The height of the line contents is normally determined from the
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1589 maximum height of any character or image on that display line,
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1590 including the final newline if there is one. (A line that is
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1591 continued doesn't include a final newline.) In the most common case,
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1592 the line height equals the height of the default frame font.
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1593
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1594 There are several ways to explicitly control or change the line
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1595 height, either by specifying an absolute height for the display line,
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1596 or by adding additional vertical space below one or all lines.
58883
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1597
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1598 @kindex line-height @r{(text property)}
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1599 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
1600 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
1601 newline.
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1602
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1603 If the property value is a list @code{(@var{height} @var{total})},
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1604 then @var{height} is used as the actual property value for the
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1605 @code{line-height}, and @var{total} specifies the total displayed
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1606 height of the line, so the line spacing added below the line equals
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1607 the @var{total} height minus the actual line height. In this case,
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1608 the other ways to specify the line spacing are ignored.
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1609
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1610 If the property value is @code{t}, the displayed height of the
59137
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1611 line is exactly what its contents demand; no line-spacing is added.
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1612 This case is useful for tiling small images or image slices without
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1613 adding blank areas between the images.
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1614
59212
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1615 If the property value is not @code{t}, it is a height spec. A height
61980
f3d536670495 Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61972
diff changeset
1616 spec stands for a numeric height value; this height spec specifies the
59137
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1617 actual line height, @var{line-height}. There are several ways to
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1618 write a height spec; here's how each of them translates into a numeric
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1619 height:
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1620
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1621 @table @code
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1622 @item @var{integer}
59137
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1623 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
1624 @item @var{float}
59137
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1625 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
1626 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
1627 @item (@var{face} . @var{ratio})
59137
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1628 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
1629 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
1630 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
1631 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
1632 @item (nil . @var{ratio})
59212
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1633 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
1634 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
1635 @end table
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1636
59212
d928e34db52a (Line Height): Total line-height is now specified
Kim F. Storm <storm@cua.dk>
parents: 59137
diff changeset
1637 Thus, any valid non-@code{t} property value specifies a height in pixels,
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1638 @var{line-height}, one way or another. If the line contents' height
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1639 is less than @var{line-height}, Emacs adds extra vertical space above
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1640 the line to achieve the total height @var{line-height}. Otherwise,
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1641 @var{line-height} has no effect.
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1642
61980
f3d536670495 Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61972
diff changeset
1643 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
1644 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
1645 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
1646 parts of Emacs text.
58883
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1647
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1648 @vindex default-line-spacing
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1649 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
1650 @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
1651 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
1652 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
1653 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
1654 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
1655 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
1656
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1657 @vindex line-spacing
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1658 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
1659 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
1660 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
1661 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
1662 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
1663
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1664 @kindex line-spacing @r{(text property)}
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1665 Finally, a newline can have a @code{line-spacing} text or overlay
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1666 property that controls the height of the display line ending with that
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
1667 newline. The property value overrides the default frame line spacing
58902
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1668 and the buffer local @code{line-spacing} variable.
e1ad27c7a13c (Line Height): Rewrite text for clarity.
Richard M. Stallman <rms@gnu.org>
parents: 58883
diff changeset
1669
59137
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1670 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
1671 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
1672 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
1673 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
1674 height.
d7025bc399f1 (Line Height): Further clarify.
Richard M. Stallman <rms@gnu.org>
parents: 58902
diff changeset
1675
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1676 @node Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1677 @section Faces
40469
aa8474236e9e Index "faces" instead of "face".
Richard M. Stallman <rms@gnu.org>
parents: 40310
diff changeset
1678 @cindex faces
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1679
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1680 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
1681 family, foreground color, background color, optional underlining, and
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1682 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
1683 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
1684 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
1685 comes with.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1686
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1687 @cindex face id
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1688 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
1689 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
1690 faces in Lisp programs by the symbols that name them.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1691
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1692 @defun facep object
63777
fd183c9e3b18 (Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63734
diff changeset
1693 This function returns @code{t} if @var{object} is a face name string
fd183c9e3b18 (Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63734
diff changeset
1694 or symbol (or if it is a vector of the kind used internally to record
fd183c9e3b18 (Faces): `facep' returns t for strings that are face names.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63734
diff changeset
1695 face data). It returns @code{nil} otherwise.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1696 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
1697
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1698 Each face name is meaningful for all frames, and by default it has the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1699 same meaning in all frames. But you can arrange to give a particular
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1700 face name a special meaning in one frame if you wish.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1701
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1702 @menu
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1703 * 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
1704 * 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
1705 * 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
1706 * 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
1707 * 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
1708 * Face Functions:: How to define and examine faces.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1709 * Auto Faces:: Hook for automatic face assignment.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1710 * Font Lookup:: Looking up the names of available fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1711 and information about them.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1712 * Fontsets:: A fontset is a collection of fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1713 that handle a range of character sets.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1714 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1715
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1716 @node Defining Faces
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1717 @subsection Defining Faces
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1718
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1719 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
1720 kind of customization item (@pxref{Customization}) which the user can
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1721 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
1722 emacs, The GNU Emacs Manual}).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1723
66143
a055e5294831 (Progress, Defining Faces):
Juri Linkov <juri@jurta.org>
parents: 65799
diff changeset
1724 @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
1725 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
1726 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
1727 and it should not end in @samp{-face} (that would be redundant). The
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1728 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
1729 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
1730 @code{defcustom} (@pxref{Common Keywords}).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1731
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1732 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
1733 @var{spec}, then uses any customizations that were read from the
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1734 init file (@pxref{Init File}) to override that specification.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1735
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1736 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
1737 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
1738 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
1739 @sc{car}, @var{display}, specifies a class of terminals. (The first
68084
9b969687ff7c Fix typos.
Eli Zaretskii <eliz@gnu.org>
parents: 67047
diff changeset
1740 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
1741 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
1742 @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
1743 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
1744 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
1745 @code{custom-face-attributes}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1746
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1747 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
1748 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
1749 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
1750 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
1751
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1752 @table @asis
61854
60784460465e (Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents: 60995
diff changeset
1753 @item @code{default}
60784460465e (Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents: 60995
diff changeset
1754 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
1755 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
1756 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
1757 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
1758
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1759 @item @code{t}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1760 This element of @var{spec} matches all frames. Therefore, any
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1761 subsequent elements of @var{spec} are never used. Normally
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1762 @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
1763
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1764 @item a list
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1765 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
1766 @code{(@var{characteristic} @var{value}@dots{})}. Here
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1767 @var{characteristic} specifies a way of classifying frames, and the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1768 @var{value}s are possible classifications which @var{display} should
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1769 apply to. Here are the possible values of @var{characteristic}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1770
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1771 @table @code
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1772 @item type
32802
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1773 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
1774 graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console),
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1775 @code{w32} (for MS Windows 9X/NT), or @code{tty} (a non-graphics-capable
66f219c7e8ca (Defining Faces): Document `graphic' display type in face specs.
Miles Bader <miles@gnu.org>
parents: 32552
diff changeset
1776 display).
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1777
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1778 @item class
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1779 What kinds of colors the frame supports---either @code{color},
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1780 @code{grayscale}, or @code{mono}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1781
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1782 @item background
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1783 The kind of background---either @code{light} or @code{dark}.
45745
394a19fc134e defface `supports' predicate
Miles Bader <miles@gnu.org>
parents: 44281
diff changeset
1784
54156
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1785 @item min-colors
61854
60784460465e (Defining Faces): Document `default' elements of defface spec.
Richard M. Stallman <rms@gnu.org>
parents: 60995
diff changeset
1786 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
1787 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
1788 @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
1789
45745
394a19fc134e defface `supports' predicate
Miles Bader <miles@gnu.org>
parents: 44281
diff changeset
1790 @item supports
46170
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1791 Whether or not the frame can display the face attributes given in
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1792 @var{value}@dots{} (@pxref{Face Attributes}). See the documentation
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1793 for the function @code{display-supports-face-attributes-p} for more
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1794 information on exactly how this testing is done. @xref{Display Face
115fa2a7cd26 Tweak text a bit.
Miles Bader <miles@gnu.org>
parents: 45750
diff changeset
1795 Attribute Testing}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1796 @end table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1797
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1798 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
1799 given @var{characteristic}, any of those values is acceptable. If
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1800 @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
1801 different @var{characteristic}; then @emph{each} characteristic of the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1802 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
1803 @var{display}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1804 @end table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1805 @end defmac
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1806
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1807 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
1808
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1809 @example
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1810 @group
54156
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1811 '((((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
1812 :background "blue3")
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1813 @end group
54156
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1814 (((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
1815 :background "lightgoldenrod2")
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1816 (((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
1817 :background "blue3")
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1818 (((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
1819 :background "lightgoldenrod2")
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1820 (((class color) (min-colors 8))
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1821 :background "blue" :foreground "white")
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1822 (((type tty) (class mono))
54156
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1823 :inverse-video t)
aa281cba47ea (Defining Faces): Add description for min-colors. Update example.
Eli Zaretskii <eliz@gnu.org>
parents: 54023
diff changeset
1824 (t :background "gray"))
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1825 @group
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1826 "Basic face for highlighting the region."
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1827 :group 'basic-faces)
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1828 @end group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1829 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1830
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1831 Internally, @code{defface} uses the symbol property
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1832 @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
1833 @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
1834 with the customization buffer, @code{customized-face} for the
2b9aa367d2f8 (Defining Faces): Add `customized-face'.
Juri Linkov <juri@jurta.org>
parents: 63583
diff changeset
1835 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
1836 saved, and @code{face-documentation} for the documentation string.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1837
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1838 @defopt frame-background-mode
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1839 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
1840 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
1841 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
1842 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
1843 as if they had a light background.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1844 @end defopt
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1845
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1846 @node Face Attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1847 @subsection Face Attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1848 @cindex face attributes
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1849
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1850 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
1851 attributes}. This table lists all the face attributes, and what they
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1852 mean. Note that in general, more than one face can be specified for a
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1853 given piece of text; when that happens, the attributes of all the faces
59286
785b3315a07c (Face Attributes): Correct xref to renamed node.
Luc Teirlinck <teirllm@auburn.edu>
parents: 59277
diff changeset
1854 are merged to specify how to display the text. @xref{Displaying Faces}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1855
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
1856 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
1857 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
1858 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
1859 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
1860 specify all attributes.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1861
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1862 Some of these font attributes are meaningful only on certain kinds of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1863 displays---if your display cannot handle a certain attribute, the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1864 attribute is ignored. (The attributes @code{:family}, @code{:width},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1865 @code{:height}, @code{:weight}, and @code{:slant} correspond to parts of
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1866 an X Logical Font Descriptor.)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1867
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1868 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1869 @item :family
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1870 Font family name, or fontset name (@pxref{Fontsets}). If you specify a
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1871 font family name, the wild-card characters @samp{*} and @samp{?} are
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1872 allowed.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1873
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1874 @item :width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1875 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
1876 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
1877 @code{extra-condensed}, @code{condensed}, @code{semi-condensed},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1878 @code{normal}, @code{semi-expanded}, @code{expanded},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1879 @code{extra-expanded}, or @code{ultra-expanded}.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1880
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1881 @item :height
32089
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1882 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
1883 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
1884 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
1885 (from the underlying face), and should return the new height.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1886
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1887 @item :weight
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1888 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
1889 @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
1890 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light},
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1891 or @code{ultra-light}.
25809
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1892
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1893 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
1894 extra bright, and any weight less than normal is displayed as
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1895 half-bright (provided the terminal supports the feature).
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1896
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1897 @item :slant
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1898 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
1899 @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
1900
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1901 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
1902 the terminal supports the feature.
89230444d638 patched by pjr from diff by rms
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
1903
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1904 @item :foreground
59277
120ce8e206a5 (Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents: 59212
diff changeset
1905 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
1906 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
1907 @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
1908 @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
1909 blue, and @samp{#ffffff} is white.)
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
1910
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1911 @item :background
59277
120ce8e206a5 (Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents: 59212
diff changeset
1912 Background color, a string, like the foreground color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1913
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1914 @item :inverse-video
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1915 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
1916 value should be @code{t} (yes) or @code{nil} (no).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1917
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1918 @item :stipple
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1919 The background stipple, a bitmap.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1920
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1921 The value can be a string; that should be the name of a file containing
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1922 external-format X bitmap data. The file is found in the directories
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1923 listed in the variable @code{x-bitmap-file-path}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1924
40310
34f1a01f25fa *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 39404
diff changeset
1925 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
1926 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
1927 @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
1928 @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
1929 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
1930 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
1931 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
1932
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1933 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
1934
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1935 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
1936 used automatically to handle certain shades of gray.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1937
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1938 @item :underline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1939 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
1940 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
1941 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
1942 value @code{nil} means do not underline.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1943
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1944 @item :overline
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1945 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
1946 The value is used like that of @code{:underline}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1947
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1948 @item :strike-through
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1949 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
1950 color. The value is used like that of @code{:underline}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1951
32089
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1952 @item :inherit
15b8a53f1d7a (Face Attributes): Add description of new :inherit face attribute, and
Miles Bader <miles@gnu.org>
parents: 31373
diff changeset
1953 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
1954 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
1955 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
1956 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
1957 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
1958
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1959 @item :box
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1960 Whether or not a box should be drawn around characters, its color, the
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1961 width of the box lines, and 3D appearance.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1962 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1963
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1964 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
1965 they mean:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1966
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1967 @table @asis
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1968 @item @code{nil}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1969 Don't draw a box.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1970
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1971 @item @code{t}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1972 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
1973
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1974 @item @var{color}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1975 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
1976
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1977 @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
1978 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
1979 @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
1980
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1981 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
1982 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
1983 color of the face for 3D boxes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1984
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1985 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
1986 @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
1987 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
1988 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
1989 is used.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1990 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1991
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
1992 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
1993 @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
1994 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
1995 semi-obsolete, but they still work:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1996
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1997 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
1998 @item :font
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
1999 This attribute specifies the font name.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2000
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2001 @item :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2002 A non-@code{nil} value specifies a bold font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2003
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2004 @item :italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2005 A non-@code{nil} value specifies an italic font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2006 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2007
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
2008 For compatibility, you can still set these ``attributes'', even
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
2009 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
2010
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2011 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2012 @item :font
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2013 You can specify an X font name as the ``value'' of this ``attribute'';
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2014 that sets the @code{:family}, @code{:width}, @code{:height},
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2015 @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
2016
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2017 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
2018 the pattern is used to set these attributes.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2019
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2020 @item :bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2021 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
2022 This actually works by setting the @code{:weight} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2023
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2024 @item :italic
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2025 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
2026 This actually works by setting the @code{:slant} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2027 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2028
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2029 @defvar x-bitmap-file-path
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2030 This variable specifies a list of directories for searching
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2031 for bitmap files, for the @code{:stipple} attribute.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2032 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2033
25911
b192e4e3a9f5 Rename pixmap-spec-p to bitmap-spec-p.
Gerd Moellmann <gerd@gnu.org>
parents: 25875
diff changeset
2034 @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
2035 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
2036 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
2037 @code{nil} otherwise.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2038 @end defun
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2039
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2040 @node Attribute Functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2041 @subsection Face Attribute Functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2042
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2043 You can modify the attributes of an existing face with the following
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2044 functions. If you specify @var{frame}, they affect just that frame;
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2045 otherwise, they affect all frames as well as the defaults that apply to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2046 new frames.
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 @tindex set-face-attribute
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2049 @defun set-face-attribute face frame &rest arguments
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2050 This function sets one or more attributes of face @var{face}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2051 for frame @var{frame}. If @var{frame} is @code{nil}, it sets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2052 the attribute for all frames, and the defaults for new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2053
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2054 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
2055 the values for them. They should consist of alternating attribute names
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2056 (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
2057 Thus,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2058
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2059 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2060 (set-face-attribute 'foo nil
46721
12862351ee03 Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents: 46338
diff changeset
2061 :width 'extended
12862351ee03 Fix set-face-attribute example.
Richard M. Stallman <rms@gnu.org>
parents: 46338
diff changeset
2062 :weight 'bold
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2063 :underline "red")
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2064 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2065
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2066 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2067 sets the attributes @code{:width}, @code{:weight} and @code{:underline}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2068 to the corresponding values.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2069 @end defun
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 @tindex face-attribute
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2072 @defun face-attribute face attribute &optional frame inherit
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2073 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
2074 @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
2075 that means the selected frame (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2076
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2077 If @var{frame} is @code{t}, the value is the default for
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2078 @var{face} for new frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2079
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
2080 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
2081 @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
2082 @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
2083 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
2084 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
2085 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
2086 @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
2087 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
2088 absolute.
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2089
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2090 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
2091 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
2092 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
2093 (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
2094
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2095 For example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2096
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2097 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2098 (face-attribute 'bold :weight)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2099 @result{} bold
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2100 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2101 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2102
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2103 The functions above did not exist before Emacs 21. For compatibility
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2104 with older Emacs versions, you can use the following functions to set
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2105 and examine the face attributes which existed in those versions.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2106
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2107 @tindex face-attribute-relative-p
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2108 @defun face-attribute-relative-p attribute value
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
2109 This function returns non-@code{nil} if @var{value}, when used as
46240
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2110 the value of the face attribute @var{attribute}, is relative (that is,
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2111 if it modifies an underlying or inherited value of @var{attribute}).
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2112 @end defun
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2113
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2114 @tindex merge-face-attribute
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2115 @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
2116 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
2117 @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
2118 @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
2119 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
2120 @end defun
df64f9f41c5f Add entries for face-attribute-relative-p, merge-face-attribute.
Miles Bader <miles@gnu.org>
parents: 46170
diff changeset
2121
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2122 @defun set-face-foreground face color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2123 @defunx set-face-background face color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2124 These functions set the foreground (or background, respectively) color
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2125 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
2126 string, the name of a color.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2127
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2128 Certain shades of gray are implemented by stipple patterns on
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2129 black-and-white screens.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2130 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2131
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2132 @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
2133 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
2134 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
2135 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
2136 (@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
2137
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2138 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
2139 they are used automatically to handle certain shades of gray.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2140 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2141
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2142 @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
2143 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
2144 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
2145 @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
2146 @var{font}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2147 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2148
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2149 @defun set-face-bold-p face bold-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2150 This function specifies whether @var{face} should be bold. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2151 @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
2152 This actually sets the @code{:weight} attribute.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2153 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2154
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2155 @defun set-face-italic-p face italic-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2156 This function specifies whether @var{face} should be italic. If
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2157 @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
2158 This actually sets the @code{:slant} attribute.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2159 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2160
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2161 @defun set-face-underline-p face underline-p &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2162 This function sets the underline attribute of face @var{face}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2163 Non-@code{nil} means do underline; @code{nil} means don't.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2164 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2165
65073
408e294257ab (Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents: 64921
diff changeset
2166 @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
2167 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
2168 @var{face}.
408e294257ab (Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents: 64921
diff changeset
2169 @end defun
408e294257ab (Attribute Functions): Add set-face-inverse-video-p.
Juri Linkov <juri@jurta.org>
parents: 64921
diff changeset
2170
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2171 @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
2172 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
2173 @var{face}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2174 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2175
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2176 These functions examine the attributes of a face. If you don't
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2177 specify @var{frame}, they refer to the default data for new frames.
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2178 They return the symbol @code{unspecified} if the face doesn't define any
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
2179 value for that attribute.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2180
46245
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
2181 @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
2182 @defunx face-background face &optional frame inherit
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2183 These functions return the foreground color (or background color,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2184 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
2185
54777
5745bf089073 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54156
diff changeset
2186 If @var{inherit} is @code{nil}, only a color directly defined by the face is
5745bf089073 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54156
diff changeset
2187 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
2188 @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
2189 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
2190 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
2191 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
2192 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2193
46245
fb42c0446cbf Update face-foreground and face-background to mention INHERIT parameter.
Miles Bader <miles@gnu.org>
parents: 46240
diff changeset
2194 @defun face-stipple face &optional frame inherit
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2195 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
2196 @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
2197
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
2198 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
2199 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
2200 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
2201 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
2202 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
2203 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
2204 @var{inherit}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2205 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2206
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2207 @defun face-font face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2208 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
2209 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2210
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2211 @defun face-bold-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2212 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
2213 bolder than normal. It returns @code{nil} otherwise.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2214 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2215
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2216 @defun face-italic-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2217 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
2218 @code{nil} otherwise.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2219 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2220
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2221 @defun face-underline-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2222 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
2223 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2224
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2225 @defun face-inverse-video-p face &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2226 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
2227 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2228
59277
120ce8e206a5 (Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents: 59212
diff changeset
2229 @node Displaying Faces
120ce8e206a5 (Face Attributes): Describe hex color specs.
Richard M. Stallman <rms@gnu.org>
parents: 59212
diff changeset
2230 @subsection Displaying Faces
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2231
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2232 Here are the ways to specify which faces to use for display of text:
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2233
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2234 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2235 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2236 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
2237 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
2238 face is used only when no other face is specified.)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2239
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
2240 @item
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
2241 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
2242 @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
2243 before @code{default}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2244
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2245 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2246 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
2247 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
2248 Properties}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2249
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2250 If the character has a @code{mouse-face} property, that is used instead
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2251 of the @code{face} property when the mouse is ``near enough'' to the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2252 character.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2253
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2254 @item
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2255 With overlays. An overlay can have @code{face} and @code{mouse-face}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2256 properties too; they apply to all the text covered by the overlay.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2257
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2258 @item
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2259 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
2260 highlighted with the face @code{region} (@pxref{Standard Faces,,,
88aad5396aac (Standard Faces): Delete node.
Juri Linkov <juri@jurta.org>
parents: 65073
diff changeset
2261 emacs, The GNU Emacs Manual}).
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2262
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2263 @item
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
2264 With special glyphs. Each glyph can specify a particular face
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2265 number. @xref{Glyphs}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2266 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2267
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2268 If these various sources together specify more than one face for a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2269 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
2270 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
2271 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
2272 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
2273 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
2274 @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
2275 line or a header line), and last the @code{default} face.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2276
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2277 When multiple overlays cover one character, an overlay with higher
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2278 priority overrides those with lower priority. @xref{Overlays}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2279
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2280 @node Font Selection
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2281 @subsection Font Selection
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2282
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2283 @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
2284 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
2285 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
2286 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
2287 it is.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2288
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2289 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
2290 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
2291 family, a font pattern is constructed.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2292
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2293 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
2294 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
2295 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
2296 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
2297 ``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
2298 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
2299 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
2300 try.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2301
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2302 @defvar face-font-selection-order
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2303 @tindex face-font-selection-order
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2304 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
2305 @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2306 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
2307 decreasing importance.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2308
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2309 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
2310 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
2311 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
2312
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2313 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
2314 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
2315 (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
2316 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
2317 non-normal faces contrast with normal ones, whenever possible.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2318
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2319 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
2320 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
2321 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
2322 and so on.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2323
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2324 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
2325 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
2326 @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
2327 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
2328 @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
2329 quite right.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2330 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2331
33373
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2332 @defvar face-font-family-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2333 @tindex face-font-family-alternatives
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2334 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
2335 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
2336 this form:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2337
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2338 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2339 (@var{family} @var{alternate-families}@dots{})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2340 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2341
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2342 If @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
2343 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
2344 family that does exist.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2345 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2346
33373
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2347 @defvar face-font-registry-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2348 @tindex face-font-registry-alternatives
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2349 This variable lets you specify alternative font registries to try, if a
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2350 given registry is specified and doesn't exist. Each element should have
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2351 this form:
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2352
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2353 @example
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2354 (@var{registry} @var{alternate-registries}@dots{})
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2355 @end example
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2356
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2357 If @var{registry} is specified but not available, Emacs will try the
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2358 other registries given in @var{alternate-registries}, one by one,
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2359 until it finds a registry that does exist.
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2360 @end defvar
701833d4b661 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32840
diff changeset
2361
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2362 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
2363 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
2364 XFree86 servers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2365
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2366 @defvar scalable-fonts-allowed
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2367 @tindex scalable-fonts-allowed
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2368 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
2369 @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
2370 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
2371
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2372 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
2373 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
2374 expression in the list. For example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2375
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2376 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2377 (setq scalable-fonts-allowed '("muleindian-2$"))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2378 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2379
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2380 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2381 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
2382 @end defvar
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2383
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2384 @defun clear-face-cache &optional unload-p
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2385 @tindex clear-face-cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2386 This function clears the face cache for all frames.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2387 If @var{unload-p} is non-@code{nil}, that means to unload
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2388 all unused fonts as well.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2389 @end defun
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2390
52002
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2391 @defvar face-font-rescale-alist
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2392 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
2393 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
2394
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2395 @example
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2396 (@var{fontname-regexp} . @var{scale-factor})
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2397 @end example
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2398
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2399 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
2400 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
2401 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
2402 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
2403 nominal heights and widths would suggest.
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2404 @end defvar
26d4153f70a1 (Width): Use \s syntax in example.
Richard M. Stallman <rms@gnu.org>
parents: 51652
diff changeset
2405
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2406 @node Face Functions
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2407 @subsection Functions for Working with Faces
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2408
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2409 Here are additional functions for creating and working with faces.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2410
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2411 @defun make-face name
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2412 This function defines a new face named @var{name}, initially with all
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2413 attributes @code{nil}. It does nothing if there is already a face named
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2414 @var{name}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2415 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2416
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2417 @defun face-list
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2418 This function returns a list of all defined face names.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2419 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2420
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2421 @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
2422 This function defines a face named @var{new-name} as a copy of the existing
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2423 face named @var{old-face}. It creates the face @var{new-name} if that
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2424 doesn't already exist.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2425
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2426 If the optional argument @var{frame} is given, this function applies
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2427 only to that frame. Otherwise it applies to each frame individually,
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2428 copying attributes from @var{old-face} in each frame to @var{new-face}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2429 in the same frame.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2430
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2431 If the optional argument @var{new-frame} is given, then @code{copy-face}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2432 copies the attributes of @var{old-face} in @var{frame} to @var{new-name}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2433 in @var{new-frame}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2434 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2435
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
2436 @defun face-id face
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
2437 This function returns the face number of face @var{face}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2438 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2439
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
2440 @defun face-documentation face
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
2441 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
2442 @code{nil} if none was specified for it.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
2443 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
2444
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2445 @defun face-equal face1 face2 &optional frame
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2446 This returns @code{t} if the faces @var{face1} and @var{face2} have the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2447 same attributes for display.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2448 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2449
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2450 @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
2451 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
2452 differently from the default face.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
2453 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
2454
63659
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2455 @cindex face alias
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2456 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
2457 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
2458 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
2459 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
2460
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2461 @example
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2462 (put 'modeline 'face-alias 'mode-line)
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2463 @end example
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2464
ce9e9d1055bf (Face Functions): Mention face aliases.
Glenn Morris <rgm@gnu.org>
parents: 63640
diff changeset
2465
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2466 @node Auto Faces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2467 @subsection Automatic Face Assignment
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2468 @cindex automatic face assignment
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2469 @cindex faces, automatic choice
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2470
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2471 @cindex Font-Lock mode
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
2472 This hook is used for automatically assigning faces to text in the
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
2473 buffer. It is part of the implementation of Font-Lock mode.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2474
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2475 @tindex fontification-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2476 @defvar fontification-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2477 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
2478 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
2479
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2480 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
2481 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
2482 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
2483
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2484 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
2485 @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
2486 @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
2487 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
2488 already.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2489
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2490 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
2491 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
2492 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
2493 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
2494 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
2495
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2496 For efficiency, we recommend writing these functions so that they
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2497 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
2498 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2499
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2500 @node Font Lookup
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2501 @subsection Looking Up Fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2502
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2503 @defun x-list-fonts pattern &optional face frame maximum
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2504 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
2505 @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
2506 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
2507 @var{face} currently is on @var{frame}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2508
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2509 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
2510 characters: the @samp{*} character matches any substring, and the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2511 @samp{?} character matches any single character. Pattern matching
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2512 of font names ignores case.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2513
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2514 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
2515 (a symbol) and @var{frame} should be a frame.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2516
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2517 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
2518 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
2519 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
2520 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
2521 many fonts match the pattern.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2522 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2523
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2524 @defun x-family-fonts &optional family frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2525 @tindex x-family-fonts
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2526 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
2527 @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
2528 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
2529 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
2530 contain the wildcards @samp{?} and @samp{*}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2531
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2532 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
2533 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
2534 (@pxref{Input Focus}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2535
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2536 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
2537
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2538 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2539 [@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
2540 @var{fixed-p} @var{full} @var{registry-and-encoding}]
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2541 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2542
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2543 The first five elements correspond to face attributes; if you
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2544 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
2545
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2546 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
2547 @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
2548 @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
2549 @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
2550 encoding of the font.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2551
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2552 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
2553 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2554
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2555 @defun x-font-family-list &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2556 @tindex x-font-family-list
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2557 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
2558 @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
2559 describes the selected frame's display (@pxref{Input Focus}).
25751
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 The value is a list of elements of this form:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2562
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2563 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2564 (@var{family} . @var{fixed-p})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2565 @end example
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 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2568 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
2569 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
2570 @end defun
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 @defvar font-list-limit
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2573 @tindex font-list-limit
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2574 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
2575 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
2576 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
2577 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
2578 currently 100.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2579 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2580
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2581 @node Fontsets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2582 @subsection Fontsets
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2583
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2584 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
2585 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
2586 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
2587 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
2588 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
2589 information about defining a fontset under Lisp program control.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2590
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2591 @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
2592 This function defines a new fontset according to the specification
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2593 string @var{fontset-spec}. The string should have this format:
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 @smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2596 @var{fontpattern}, @r{[}@var{charsetname}:@var{fontname}@r{]@dots{}}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2597 @end smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2598
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2599 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2600 Whitespace characters before and after the commas are ignored.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2601
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2602 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
2603 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
2604 @samp{fontset-@var{alias}}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2605
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2606 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
2607 @var{fontpattern} in its entirety. The short name is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2608 @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
2609 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
2610 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
2611 function does nothing.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2612
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2613 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
2614 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
2615 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
2616 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
2617 status.
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 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
2620 See below for the details.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2621 @end defun
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 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
2624 use (in this fontset) for one particular character set. Here,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2625 @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
2626 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
2627 times in the specification string.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2628
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2629 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
2630 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
2631 @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
2632 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
2633 with @samp{ISO8859-1}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2634
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2635 In addition, when several consecutive fields are wildcards, Emacs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2636 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
2637 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
2638 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
2639 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
2640
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2641 Thus if @var{fontpattern} is this,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2642
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2643 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2644 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2645 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2646
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2647 @noindent
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52940
diff changeset
2648 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
2649
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2650 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2651 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2652 @end example
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 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
2656
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2657 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2658 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2659 @end example
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 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
2662 specification. Most X distributions include only Chinese fonts that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2663 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
2664 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
2665
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2666 @smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2667 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2668 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2669 @end smallexample
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2670
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2671 @noindent
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2672 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
2673 @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
2674 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
2675 field.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
2676
52932
eb3f1895daff (Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents: 52923
diff changeset
2677 @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
2678 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
2679 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
2680
52940
cac3cb68235c (Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents: 52932
diff changeset
2681 If @var{name} is @code{nil}, this function modifies the default
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
2682 fontset, whose short name is @samp{fontset-default}.
52940
cac3cb68235c (Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents: 52932
diff changeset
2683
cac3cb68235c (Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents: 52932
diff changeset
2684 @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
2685 @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
2686 @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
2687 (inclusive).
52932
eb3f1895daff (Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents: 52923
diff changeset
2688
eb3f1895daff (Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents: 52923
diff changeset
2689 @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
2690 @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
2691
52940
cac3cb68235c (Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents: 52932
diff changeset
2692 @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
2693 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
2694 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
2695 (possibly including an encoding name at the tail).
cac3cb68235c (Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents: 52932
diff changeset
2696
cac3cb68235c (Fontsets): Fix texinfo usage.
Kenichi Handa <handa@m17n.org>
parents: 52932
diff changeset
2697 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
2698 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
2699 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
2700
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
2701 @smallexample
52932
eb3f1895daff (Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents: 52923
diff changeset
2702 (set-fontset-font nil 'japanese-jisx0208 '(nil . "JISX0208.1983"))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
2703 @end smallexample
52932
eb3f1895daff (Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents: 52923
diff changeset
2704 @end defun
eb3f1895daff (Fontsets): Add description of the function set-fontset-font.
Kenichi Handa <handa@m17n.org>
parents: 52923
diff changeset
2705
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2706 @defun char-displayable-p char
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2707 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
2708 @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
2709 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
2710
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2711 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
2712 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
2713 @end defun
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2714
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2715 @node Fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2716 @section Fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2717 @cindex Fringes
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2718
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2719 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
2720 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
2721 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
2722
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
2723 @menu
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
2724 * 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
2725 * Fringe Indicators:: Displaying indicator icons in the window fringes.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2726 * Fringe Cursors:: Displaying cursors in the right fringe.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2727 * 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
2728 * 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
2729 * 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
2730 @end menu
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
2731
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
2732 @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
2733 @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
2734
65799
2d967531d264 (Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents: 65740
diff changeset
2735 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
2736 of the window fringes.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2737
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2738 @defvar fringes-outside-margins
65799
2d967531d264 (Fringe Size/Pos): Simplify and add detail.
Nick Roberts <nickrob@snap.net.nz>
parents: 65740
diff changeset
2739 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
2740 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
2741 margins. @xref{Display Margins}.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2742 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2743
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2744 @defvar left-fringe-width
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2745 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
2746 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
2747 width from the window's frame.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2748 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2749
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2750 @defvar right-fringe-width
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2751 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
2752 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
2753 width from the window's frame.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2754 @end defvar
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2755
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2756 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
2757 buffer in a window. If you change them while the buffer is visible,
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
2758 you can call @code{set-window-buffer} to display it once again in the
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
2759 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
2760
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2761 @defun set-window-fringes window left &optional right outside-margins
54023
3a7432ab26ae Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53929
diff changeset
2762 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
2763 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
2764
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2765 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
2766 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
2767 @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
2768 @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
2769 should appear outside of the display margins.
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2770 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2771
53929
3ef7a4a3c230 (Fringes): Use consistent wording.
Kim F. Storm <storm@cua.dk>
parents: 53829
diff changeset
2772 @defun window-fringes &optional window
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2773 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
2774 @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
2775 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
2776 @var{right-width} @var{outside-margins})}.
52141
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2777 @end defun
a5d4d0a7b284 (Warnings): New node, and subnodes.
Richard M. Stallman <rms@gnu.org>
parents: 52002
diff changeset
2778
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2779
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2780 @node Fringe Indicators
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2781 @subsection Fringe Indicators
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2782 @cindex fringe indicators
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2783 @cindex indicators, fringe
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2784
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2785 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
2786 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
2787 continued lines, buffer boundaries, overlay arrow, etc.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2788
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2789 @defopt indicate-empty-lines
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2790 @tindex indicate-empty-lines
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2791 @cindex fringes, and empty line indication
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2792 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
2793 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
2794 displays. @xref{Fringes}. This variable is automatically
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2795 buffer-local in every buffer.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2796 @end defopt
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2797
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2798 @defvar indicate-buffer-boundaries
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2799 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
2800 window scrolling are indicated in the window fringes.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2801
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2802 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
2803 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
2804 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
2805 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
2806 there is text below the screen.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2807
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2808 There are four kinds of basic values:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2809
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2810 @table @asis
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2811 @item @code{nil}
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2812 Don't display the icons.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2813 @item @code{left}
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2814 Display them in the left fringe.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2815 @item @code{right}
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2816 Display them in the right fringe.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2817 @item @var{anything-else}
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2818 Display the icon at the top of the window top in the left fringe, and other
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2819 in the right fringe.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2820 @end table
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2821
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2822 If value is a cons @code{(@var{angles} . @var{arrows})}, @var{angles}
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2823 controls the angle icons, and @var{arrows} controls the arrows. Both
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2824 @var{angles} and @var{arrows} work according to the table above.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2825 Thus, @code{(t . right)} places the top angle icon in the left
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2826 fringe, the bottom angle icon in the right fringe, and both arrows in
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2827 the right fringe.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2828 @end defvar
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2829
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2830 @defvar default-indicate-buffer-boundaries
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2831 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
2832 @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
2833 @end defvar
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2834
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2835 @defvar fringe-indicator-alist
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2836 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
2837 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
2838
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2839 These symbols identify the logical fringe indicators:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2840
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2841 @table @asis
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2842 @item Truncation and continuation line indicators:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2843 @code{truncation}, @code{continuation}.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2844
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2845 @item Buffer position indicators:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2846 @code{up}, @code{down},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2847 @code{top}, @code{bottom},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2848 @code{top-bottom}.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2849
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2850 @item Empty line indicator:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2851 @code{empty-line}.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2852
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2853 @item Overlay arrow indicator:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2854 @code{overlay-arrow}.
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 @item Unknown bitmap indicator:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2857 @code{unknown}.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2858 @end table
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2859
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2860 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
2861 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
2862 fringe indicator.
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 Here, @var{indicator} specifies the logical indicator type, and
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2865 @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
2866 [@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
2867 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
2868
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2869 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
2870 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
2871 @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
2872 `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
2873 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
2874 used in both left and right fringes.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2875
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2876 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
2877 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
2878 @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
2879 @code{default-fringe-indicator-alist} is used.
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2880
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2881 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
2882 @end defvar
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2883
69611
1d437dedbd3a (Fringe Indicators): Fix typos.
Nick Roberts <nickrob@snap.net.nz>
parents: 69521
diff changeset
2884 @defvar default-fringe-indicator-alist
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2885 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
2886 @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
2887 @end defvar
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2888
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2889 @table @asis
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2890 @item Standard fringe bitmaps for indicators:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2891 @code{left-arrow}, @code{right-arrow}, @code{up-arrow}, @code{down-arrow},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2892 @code{left-curly-arrow}, @code{right-curly-arrow},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2893 @code{left-triangle}, @code{right-triangle},
69611
1d437dedbd3a (Fringe Indicators): Fix typos.
Nick Roberts <nickrob@snap.net.nz>
parents: 69521
diff changeset
2894 @code{top-left-angle}, @code{top-right-angle},
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2895 @code{bottom-left-angle}, @code{bottom-right-angle},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2896 @code{left-bracket}, @code{right-bracket},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2897 @code{filled-rectangle}, @code{hollow-rectangle},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2898 @code{filled-square}, @code{hollow-square},
69067
7e42bca9af96 (Fringe Indicators, Fringe Cursors): Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 69052
diff changeset
2899 @code{vertical-bar}, @code{horizontal-bar},
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2900 @code{empty-line},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2901 @code{question-mark}.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2902 @end table
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2903
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2904 @node Fringe Cursors
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2905 @subsection Fringe Cursors
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2906 @cindex fringe cursors
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2907 @cindex cursor, fringe
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2908
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2909 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
2910 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
2911 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
2912 the current buffer's cursor type.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2913
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2914 @table @asis
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2915 @item Logical cursor types:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2916 @code{box} , @code{hollow}, @code{bar},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2917 @code{hbar}, @code{hollow-small}.
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 @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
2921 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
2922 display line.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2923
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
2924 @defvar overflow-newline-into-fringe
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2925 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
2926 counting the final newline character) are not continued. Instead,
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2927 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
2928 fringe.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
2929 @end defvar
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
2930
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2931 @defvar fringe-cursor-alist
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2932 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
2933 actual fringe bitmaps displayed in the right fringe. The value is an
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2934 alist where each element @code{(@var{cursor}. @var{bitmap})} specifies
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2935 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
2936 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
2937 @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
2938 for that logical cursor type.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2939
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2940 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
2941 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
2942 (non-local) @code{default-fringes-indicator-alist} is used.
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2943 @end defvar
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2944
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2945 @defvar default-fringes-cursor-alist
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2946 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
2947 @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
2948 @end defvar
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2949
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2950 @table @asis
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2951 @item Standard bitmaps for displaying the cursor in right fringe:
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2952 @code{filled-rectangle}, @code{hollow-rectangle},
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2953 @code{filled-square}, @code{hollow-square},
69067
7e42bca9af96 (Fringe Indicators, Fringe Cursors): Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 69052
diff changeset
2954 @code{vertical-bar}, @code{horizontal-bar}.
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2955 @end table
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2956
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2957
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
2958 @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
2959 @subsection Fringe Bitmaps
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2960 @cindex fringe bitmaps
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2961 @cindex bitmaps, fringe
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2962
69052
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2963 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
2964 logical fringe indicators for truncated or continued lines, buffer
0c26b31febaf (Fringe Indicators): New section.
Kim F. Storm <storm@cua.dk>
parents: 68946
diff changeset
2965 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
2966 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
2967 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
2968 fringe bitmaps.
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2969
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2970 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
2971 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
2972 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
2973 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
2974 @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
2975 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
2976 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
2977 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
2978 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
2979 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
2980 foreground color for the bitmap.
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2981
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2982 @defun fringe-bitmaps-at-pos &optional pos window
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2983 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
2984 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
2985 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
2986 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
2987 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
2988 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
2989
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2990 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
2991 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
2992 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
2993 @var{window}.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2994 @end defun
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2995
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2996 @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
2997 @subsection Customizing Fringe Bitmaps
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
2998
57274
271dfa08c2d0 (Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents: 57225
diff changeset
2999 @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
3000 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
3001 or replaces an existing bitmap with that name.
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3002
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3003 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
3004 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
3005 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
3006 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
3007 to the rightmost pixel of the bitmap.
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3008
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3009 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
3010 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
3011 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
3012 @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
3013
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3014 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
3015 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
3016 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
3017 or @code{bottom}.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3018
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3019 The @var{align} argument may also be a list @code{(@var{align}
57225
27349bd528f6 Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57221
diff changeset
3020 @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
3021 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
3022 @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
3023 height.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3024
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3025 The return value on success is an integer identifying the new bitmap.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3026 You should save that integer in a variable so it can be used to select
57274
271dfa08c2d0 (Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents: 57225
diff changeset
3027 this bitmap.
271dfa08c2d0 (Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents: 57225
diff changeset
3028
271dfa08c2d0 (Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents: 57225
diff changeset
3029 This function signals an error if there are no more free bitmap slots.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3030 @end defun
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3031
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3032 @defun destroy-fringe-bitmap bitmap
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3033 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
3034 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
3035 restores the standard definition of that bitmap, instead of
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3036 eliminating it entirely.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3037 @end defun
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3038
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3039 @defun set-fringe-bitmap-face bitmap &optional face
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3040 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
3041 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
3042 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
3043
60958
85b21e63d5d4 (Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents: 60868
diff changeset
3044 @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
3045 @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
3046 @end defun
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3047
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3048 @node Overlay Arrow
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3049 @subsection The Overlay Arrow
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3050 @cindex overlay arrow
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3051
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3052 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
3053 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
3054 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
3055 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
3056 @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
3057
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3058 @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
3059 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
3060 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
3061 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
3062 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
3063 @end defvar
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3064
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3065 @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
3066 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
3067 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
3068 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
3069 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
3070 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
3071 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
3072 overwritten.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3073
66341
8ad92df59512 (Overlay Arrow): Clarify about local bindings of overlay-arrow-position.
Richard M. Stallman <rms@gnu.org>
parents: 66209
diff changeset
3074 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
3075 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
3076 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
3077 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
3078 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
3079 @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
3080 @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
3081 @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
3082 @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
3083 @end defvar
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3084
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3085 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
3086 @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
3087
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3088 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
3089 @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
3090
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3091 @defvar overlay-arrow-variable-list
61980
f3d536670495 Fix typos and Texinfo usage.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61972
diff changeset
3092 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
3093 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
3094 @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
3095 this list.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3096 @end defvar
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3097
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3098 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
3099 @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
3100 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
3101 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
3102 overlay arrow position. If either property is not set, the default
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3103 (@code{overlay-arrow-string} or @code{overlay-arrow-fringe-bitmap}) is
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3104 used.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3105
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3106 @node Scroll Bars
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3107 @section Scroll Bars
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3108
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3109 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
3110 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
3111 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
3112 @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
3113 meaning the default). @xref{Layout Parameters}.
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3114
60958
85b21e63d5d4 (Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents: 60868
diff changeset
3115 @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
3116 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
3117 @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
3118 @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
3119 @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
3120 (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
3121 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
3122 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
3123 @end defun
85b21e63d5d4 (Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents: 60868
diff changeset
3124
58883
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
3125 @vindex vertical-scroll-bar
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
3126 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
3127 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
3128 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
3129 @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
3130 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
3131
eb1bd3031b13 (Display): Add node "Line Height" to menu.
Kim F. Storm <storm@cua.dk>
parents: 58496
diff changeset
3132 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
3133 @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
3134
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3135 @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
3136 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
3137 @var{window}.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3138
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3139 @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
3140 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
3141 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
3142 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
3143 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
3144
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3145 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
3146 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
3147 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
3148 selected window is used.
52483
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3149 @end defun
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3150
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3151 @defun window-scroll-bars &optional window
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3152 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
3153 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
3154 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
3155 @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
3156 @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
3157 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
3158 bar actually occupies.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3159
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3160 @var{horizontal-type} is not actually meaningful.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3161 @end defun
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3162
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3163 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
3164 @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
3165 @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
3166 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
3167 @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
3168 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
3169 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
3170 specifying the same buffer that is already displayed.
3bbb565fa7ac (Fontsets): Add char-displayable-p.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
3171
58496
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
3172 @defvar scroll-bar-mode
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
3173 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
3174 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
3175 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
3176 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
3177 @end defvar
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
3178
60958
85b21e63d5d4 (Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents: 60868
diff changeset
3179 @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
3180 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
3181 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
3182 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
3183 @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
3184 @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
3185 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
3186 account.
85b21e63d5d4 (Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents: 60868
diff changeset
3187 @end defun
85b21e63d5d4 (Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change.
Richard M. Stallman <rms@gnu.org>
parents: 60868
diff changeset
3188
58496
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
3189 @defvar scroll-bar-width
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
3190 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
3191 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
3192 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
3193 @end defvar
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
3194
57201
2950fcfcfa44 Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57193
diff changeset
3195 @node Pointer Shape
2950fcfcfa44 Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57193
diff changeset
3196 @section Pointer Shape
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3197
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3198 Normally, the mouse pointer has the @code{text} shape over text and
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3199 the @code{arrow} shape over window areas which do not correspond to
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3200 any buffer text. You can specify the mouse pointer shape over text or
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3201 images via the @code{pointer} text property, and for images with the
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3202 @code{:pointer} and @code{:map} image properties.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3203
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3204 The available pointer shapes are: @code{text} (or @code{nil}),
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3205 @code{arrow}, @code{hand}, @code{vdrag}, @code{hdrag},
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3206 @code{modeline}, and @code{hourglass}.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3207
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3208 @defvar void-text-area-pointer
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3209 @tindex void-text-area-pointer
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3210 This variable specifies the mouse pointer shape in void text areas,
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3211 i.e. the areas after the end of a line or below the last line in the
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3212 buffer. The default is to use the @code{arrow} (non-text) pointer.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3213 @end defvar
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3214
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3215 @node Display Property
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3216 @section The @code{display} Property
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3217 @cindex display specification
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3218 @kindex display @r{(text property)}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3219
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3220 The @code{display} text property (or overlay property) is used to
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3221 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
3222 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
3223 display specification, or a list or vector containing several display
60676
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3224 specifications.
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3225
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3226 Some kinds of @code{display} properties specify something to display
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3227 instead of the text that has the property. In this case, ``the text''
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3228 means all the consecutive characters that have the same Lisp object as
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3229 their @code{display} property; these characters are replaced as a
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3230 single unit. By contrast, characters that have similar but distinct
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3231 Lisp objects as their @code{display} properties are handled
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3232 separately. Here's a function that illustrates this point:
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3233
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3234 @smallexample
60676
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3235 (defun foo ()
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3236 (goto-char (point-min))
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3237 (dotimes (i 5)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3238 (let ((string (concat "A")))
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3239 (put-text-property (point) (1+ (point)) 'display string)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3240 (forward-char 1)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3241 (put-text-property (point) (1+ (point)) 'display string)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3242 (forward-char 1))))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3243 @end smallexample
60676
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3244
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3245 @noindent
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3246 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
3247 @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
3248 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
3249 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
3250 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
3251 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
3252 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
3253 results:
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3254
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3255 @smallexample
60676
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3256 (defun foo ()
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3257 (goto-char (point-min))
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3258 (dotimes (i 5)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3259 (let ((string (concat "A")))
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3260 (put-text-property (point) (2+ (point)) 'display string)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3261 (put-text-property (point) (1+ (point)) 'display string)
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3262 (forward-char 2))))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3263 @end smallexample
60676
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3264
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3265 @noindent
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3266 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
3267 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
3268 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
3269 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
3270 @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
3271
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3272 The rest of this section describes several kinds of
60442
747b9fc72d5e (Forcing Redisplay): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60218
diff changeset
3273 display specifications and what they mean.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3274
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3275 @menu
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
3276 * Specified Space:: Displaying one space with a specified width.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3277 * Pixel Specification:: Specifying space width or height in pixels.
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
3278 * Other Display Specs:: Displaying an image; magnifying text; moving it
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
3279 up or down on the page; adjusting the width
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3280 of spaces within text.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3281 * Display Margins:: Displaying text or images to the side of the main text.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3282 @end menu
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3283
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3284 @node Specified Space
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3285 @subsection Specified Spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3286 @cindex spaces, specified height or width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3287 @cindex specified spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3288 @cindex variable-width spaces
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3289
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3290 To display a space of specified width and/or height, use a display
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3291 specification of the form @code{(space . @var{props})}, where
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3292 @var{props} is a property list (a list of alternating properties and
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3293 values). You can put this property on one or more consecutive
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3294 characters; a space of the specified height and width is displayed in
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3295 place of @emph{all} of those characters. These are the properties you
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
3296 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
3297
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3298 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3299 @item :width @var{width}
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3300 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
3301 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
3302 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
3303 (@pxref{Pixel Specification}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3304
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3305 @item :relative-width @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3306 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
3307 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
3308 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
3309 character, multiplied by @var{factor}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3310
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3311 @item :align-to @var{hpos}
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3312 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
3313 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
3314 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
3315 specification (@pxref{Pixel Specification}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3316 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3317
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
3318 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
3319 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
3320
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3321 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3322 @item :height @var{height}
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3323 Specifies the height of the space.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3324 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
3325 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
3326 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
3327 (@pxref{Pixel Specification}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3328
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3329 @item :relative-height @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3330 Specifies the height of the space, multiplying the ordinary height
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3331 of the text having this display specification by @var{factor}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3332
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3333 @item :ascent @var{ascent}
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3334 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
3335 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
3336 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
3337 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
3338 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
3339
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3340 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3341
44281
dfabb11c1e1a Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 43290
diff changeset
3342 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
3343
60509
b6fee46c2fad (Specified Space): Property :width is support on
Kim F. Storm <storm@cua.dk>
parents: 60503
diff changeset
3344 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
3345 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
3346 are not.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3347
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3348 @node Pixel Specification
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3349 @subsection Pixel Specification for Spaces
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3350 @cindex spaces, pixel specification
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3351
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3352 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
3353 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
3354 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
3355 as an absolute number of pixels.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3356
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3357 The following expressions are supported:
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3358
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3359 @smallexample
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3360 @group
57274
271dfa08c2d0 (Fringe Bitmaps): Use symbols rather than numbers
Kim F. Storm <storm@cua.dk>
parents: 57225
diff changeset
3361 @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
3362 @var{num} ::= @var{integer} | @var{float} | @var{symbol}
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3363 @var{unit} ::= in | mm | cm | width | height
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3364 @end group
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3365 @group
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3366 @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
3367 | scroll-bar | text
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3368 @var{pos} ::= left | center | right
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3369 @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
3370 @var{op} ::= + | -
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3371 @end group
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3372 @end smallexample
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3373
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3374 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
3375 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
3376 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
3377 buffer-local variable binding is used.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3378
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3379 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
3380 pixels per inch, millimeter, and centimeter, respectively. The
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3381 @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
3382 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
3383 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
3384
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3385 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
3386 @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
3387 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
3388
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3389 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
3390 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
3391 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
3392
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3393 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
3394 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
3395 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
3396 position has been set (by the first occurrence of one of these
57225
27349bd528f6 Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57221
diff changeset
3397 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
3398 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
3399 the left-margin, use
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3400
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3401 @example
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3402 :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
3403 @end example
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3404
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3405 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
3406 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
3407 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
3408
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3409 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
3410 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
3411 @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
3412 @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
3413 image.
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3414
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3415 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
3416 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
3417 the value of the expressions.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3418
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3419 @node Other Display Specs
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3420 @subsection Other Display Specifications
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3421
57221
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3422 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
3423 in the @code{display} text property.
18bdf278f148 (Fringes): Rewrite previous change.
Richard M. Stallman <rms@gnu.org>
parents: 57202
diff changeset
3424
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3425 @table @code
60676
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3426 @item @var{string}
44c74c24feca (Display Property): Explain the significance
Richard M. Stallman <rms@gnu.org>
parents: 60509
diff changeset
3427 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
3428
68282
6efd3312bd38 (Other Display Specs): Delete duplicate entry for
Richard M. Stallman <rms@gnu.org>
parents: 68084
diff changeset
3429 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
3430 @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
3431
68946
956ccc6ec126 (Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 68708
diff changeset
3432 @item (image . @var{image-props})
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63134
diff changeset
3433 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
3434 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
3435 instead of the text that has the display specification.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3436
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3437 @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
3438 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
3439 (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
3440 @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
3441 @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
3442 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
3443 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
3444 of the entire image.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3445
32467
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
3446 @item ((margin nil) @var{string})
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
3447 A display specification of this form means to display @var{string}
d8a494b62fbd string display property
Dave Love <fx@gnu.org>
parents: 32261
diff changeset
3448 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
3449 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
3450 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
3451 Margins}).
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
3452
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3453 @item (space-width @var{factor})
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3454 This display specification affects all the space characters within the
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3455 text that has the specification. It displays all of these spaces
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3456 @var{factor} times as wide as normal. The element @var{factor} should
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3457 be an integer or float. Characters other than spaces are not affected
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3458 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
3459
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3460 @item (height @var{height})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3461 This display specification makes the text taller or shorter.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3462 Here are the possibilities for @var{height}:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3463
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3464 @table @asis
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3465 @item @code{(+ @var{n})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3466 This means to use a font that is @var{n} steps larger. A ``step'' is
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3467 defined by the set of available fonts---specifically, those that match
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3468 what was otherwise specified for this text, in all attributes except
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3469 height. Each size for which a suitable font is available counts as
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3470 another step. @var{n} should be an integer.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3471
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3472 @item @code{(- @var{n})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3473 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
3474
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3475 @item a number, @var{factor}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3476 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
3477 as tall as the default font.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3478
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3479 @item a symbol, @var{function}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3480 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
3481 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
3482
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3483 @item anything else, @var{form}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3484 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
3485 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
3486 @code{height} bound to the current specified font height.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3487 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3488
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3489 @item (raise @var{factor})
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3490 This kind of display specification raises or lowers the text
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3491 it applies to, relative to the baseline of the line.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3492
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3493 @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
3494 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
3495 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
3496 lower down.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3497
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3498 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
3499 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
3500 faces used for the text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3501 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3502
69849
85e6a1c82a54 (Other Display Specs): Arrange a @code{DOTTED-LIST} to
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 69611
diff changeset
3503 @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
3504 @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
3505 @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
3506 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
3507 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
3508 @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
3509 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
3510 @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
3511 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
3512 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
3513 @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
3514 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
3515 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
3516 string.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3517
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3518 @node Display Margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3519 @subsection Displaying in the Margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3520 @cindex display margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3521 @cindex margins, display
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3522
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3523 A buffer can have blank areas called @dfn{display margins} on the left
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3524 and on the right. Ordinary text never appears in these areas, but you
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3525 can put things into the display margins using the @code{display}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3526 property.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3527
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3528 To put text in the left or right display margin of the window, use a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3529 display specification of the form @code{(margin right-margin)} or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3530 @code{(margin left-margin)} on it. To put an image in a display margin,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3531 use that display specification along with the display specification for
42476
fe0b84badbb1 Margin displays can't be mouse sensitive.
Richard M. Stallman <rms@gnu.org>
parents: 42297
diff changeset
3532 the image. Unfortunately, there is currently no way to make
fe0b84badbb1 Margin displays can't be mouse sensitive.
Richard M. Stallman <rms@gnu.org>
parents: 42297
diff changeset
3533 text or images in the margin mouse-sensitive.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3534
42297
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3535 If you put such a display specification directly on text in the
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3536 buffer, the specified margin display appears @emph{instead of} that
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3537 buffer text itself. To put something in the margin @emph{in
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3538 association with} certain buffer text without preventing or altering
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3539 the display of that text, put a @code{before-string} property on the
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3540 text and put the display specification on the contents of the
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3541 before-string.
c4f9d48801a8 Explain using a before-string to put something in the margin.
Richard M. Stallman <rms@gnu.org>
parents: 42082
diff changeset
3542
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3543 Before the display margins can display anything, you must give
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3544 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
3545 variables:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3546
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3547 @defvar left-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3548 @tindex left-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3549 This variable specifies the width of the left margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3550 It is buffer-local in all buffers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3551 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3552
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3553 @defvar right-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3554 @tindex right-margin-width
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3555 This variable specifies the width of the right margin.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3556 It is buffer-local in all buffers.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3557 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3558
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3559 Setting these variables does not immediately affect the window. These
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3560 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
3561 Thus, you can make changes take effect by calling
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3562 @code{set-window-buffer}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3563
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3564 You can also set the margin widths immediately.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3565
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
3566 @defun set-window-margins window left &optional right
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3567 @tindex set-window-margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3568 This function specifies the margin widths for window @var{window}.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
3569 The argument @var{left} controls the left margin and
36935
1ac3e0f3e75a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36730
diff changeset
3570 @var{right} controls the right margin (default @code{0}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3571 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3572
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3573 @defun window-margins &optional window
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3574 @tindex window-margins
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3575 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
3576 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
3577 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
3578 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3579
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3580 @node Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3581 @section Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3582 @cindex images in buffers
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3583
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3584 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
3585 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
3586 property of text that is displayed (@pxref{Display Property}).
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3587
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3588 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
3589 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
3590 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
3591 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
3592 can be used to modify the set of known names for these dynamic
57225
27349bd528f6 Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57221
diff changeset
3593 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
3594
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3595 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
3596 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3597 @code{libungif} 4.1.0), Postscript, PBM, JPEG (requiring the
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3598 @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
3599 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
3600
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3601 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
3602 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
3603 @code{pbm}, @code{jpeg}, @code{tiff}, and @code{png}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3604
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3605 @defvar image-types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3606 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
3607 potentially supported in the current configuration.
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3608 @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
3609 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
3610 unavailable dynamic libraries, for example).
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3611
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3612 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
3613 @code{image-type-available-p}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3614 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3615
56109
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3616 @defvar image-library-alist
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3617 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
3618 display them.
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3619
56437
bd1f1cbf959f (Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents: 56233
diff changeset
3620 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
3621 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
3622 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
3623 external libraries to load.
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3624
56185
4f36c90f5404 (Images): Remove redundant @vindex directives.
Juanma Barranquero <lekktu@gmail.com>
parents: 56109
diff changeset
3625 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
3626 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
3627 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
3628 they're always supported.
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3629
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3630 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
3631 into Emacs.
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3632 @end defvar
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3633
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3634 @defun image-type-available-p type
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3635 @findex image-type-available-p
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3636
56437
bd1f1cbf959f (Images): Fix Texinfo usage.
Juanma Barranquero <lekktu@gmail.com>
parents: 56233
diff changeset
3637 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
3638 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
3639 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
3640 @code{image-types}.
56109
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3641
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3642 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
3643 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
3644 @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
3645 @end defun
53374ab0a92d (Images): Document new delayed library loading, variable
Juanma Barranquero <lekktu@gmail.com>
parents: 56020
diff changeset
3646
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3647 @menu
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3648 * Image Descriptors:: How to specify an image for use in @code{:display}.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3649 * XBM Images:: Special features for XBM format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3650 * XPM Images:: Special features for XPM format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3651 * GIF Images:: Special features for GIF format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3652 * Postscript Images:: Special features for Postscript format.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3653 * Other Image Types:: Various other formats are supported.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3654 * Defining Images:: Convenient ways to define an image for later use.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3655 * Showing Images:: Convenient ways to display an image once it is defined.
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
3656 * Image Cache:: Internal mechanisms of image display.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3657 @end menu
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 @node Image Descriptors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3660 @subsection Image Descriptors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3661 @cindex image descriptor
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3662
68946
956ccc6ec126 (Other Display Specs, Image Descriptors): Revert erroneous changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 68708
diff changeset
3663 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
3664 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
3665 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
3666 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
3667 that have any special meaning are certain symbols, all of them keywords.
26400
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
3668
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
3669 Every image descriptor must contain the property @code{:type
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
3670 @var{type}} to specify the format of the image. The value of @var{type}
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
3671 should be an image type symbol; for example, @code{xpm} for an image in
53eeb3b7c785 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26221
diff changeset
3672 XPM format.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3673
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3674 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
3675 types:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3676
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3677 @table @code
36730
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
3678 @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
3679 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
3680 @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
3681 in @code{data-directory}.
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
3682
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
3683 @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
3684 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
3685 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
3686 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
3687 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
3688
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
3689 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
3690 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
3691 @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
3692 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
3693 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
3694
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
3695 @item :margin @var{margin}
1c038a1a02a1 Move :file, :data and :margin first in the table
Richard M. Stallman <rms@gnu.org>
parents: 36351
diff changeset
3696 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
3697 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
3698 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
3699 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
3700 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
3701 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
3702
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3703 @item :ascent @var{ascent}
29151
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3704 The @code{:ascent} property specifies the amount of the image's
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3705 height to use for its ascent---that is, the part above the baseline.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3706 The value, @var{ascent}, must be a number in the range 0 to 100, or
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3707 the symbol @code{center}.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3708
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3709 If @var{ascent} is a number, that percentage of the image's height is
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3710 used for its ascent.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3711
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3712 If @var{ascent} is @code{center}, the image is vertically centered
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3713 around a centerline which would be the vertical centerline of text drawn
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3714 at the position of the image, in the manner specified by the text
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3715 properties and overlays that apply to the image.
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3716
fa8f476affa7 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29102
diff changeset
3717 If this property is omitted, it defaults to 50.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3718
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3719 @item :relief @var{relief}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3720 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
3721 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
3722 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
3723 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
3724 an unpressed button.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3725
35364
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
3726 @item :conversion @var{algorithm}
19c93f3ebdce *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 35278
diff changeset
3727 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
3728 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
3729 displayed; the value, @var{algorithm}, specifies which algorithm.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3730
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3731 @table @code
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3732 @item laplace
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3733 @itemx emboss
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3734 Specifies the Laplace edge detection algorithm, which blurs out small
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3735 differences in color while highlighting larger differences. People
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3736 sometimes consider this useful for displaying the image for a
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3737 ``disabled'' button.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3738
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3739 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust})
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3740 Specifies a general edge-detection algorithm. @var{matrix} must be
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3741 either a nine-element list or a nine-element vector of numbers. A pixel
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3742 at position @math{x/y} in the transformed image is computed from
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3743 original pixels around that position. @var{matrix} specifies, for each
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3744 pixel in the neighborhood of @math{x/y}, a factor with which that pixel
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3745 will influence the transformed pixel; element @math{0} specifies the
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3746 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3747 the pixel at @math{x/y-1} etc., as shown below:
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3748 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3749 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3750 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3751 x-1/y & x/y & x+1/y \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3752 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3753 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3754 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3755 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3756 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3757 (x-1/y-1 x/y-1 x+1/y-1
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3758 x-1/y x/y x+1/y
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3759 x-1/y+1 x/y+1 x+1/y+1)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3760 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3761 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3762
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3763 The resulting pixel is computed from the color intensity of the color
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3764 resulting from summing up the RGB values of surrounding pixels,
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3765 multiplied by the specified factors, and dividing that sum by the sum
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3766 of the factors' absolute values.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3767
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3768 Laplace edge-detection currently uses a matrix of
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3769 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3770 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3771 $$\pmatrix{1 & 0 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3772 0& 0 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3773 9 & 9 & -1 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3774 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3775 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3776 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3777 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3778 (1 0 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3779 0 0 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3780 9 9 -1)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3781 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3782 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3783
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3784 Emboss edge-detection uses a matrix of
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3785 @iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3786 @tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3787 $$\pmatrix{ 2 & -1 & 0 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3788 -1 & 0 & 1 \cr
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3789 0 & 1 & -2 \cr}$$
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3790 @end tex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3791 @end iftex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3792 @ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3793 @display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3794 ( 2 -1 0
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3795 -1 0 1
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3796 0 1 -2)
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3797 @end display
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3798 @end ifnottex
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3799
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3800 @item disabled
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3801 Specifies transforming the image so that it looks ``disabled''.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3802 @end table
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3803
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3804 @item :mask @var{mask}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3805 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3806 a clipping mask for the image, so that the background of a frame is
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3807 visible behind the image. If @var{bg} is not specified, or if @var{bg}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3808 is @code{t}, determine the background color of the image by looking at
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3809 the four corners of the image, assuming the most frequently occurring
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3810 color from the corners is the background color of the image. Otherwise,
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3811 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})}
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3812 specifying the color to assume for the background of the image.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3813
51652
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
3814 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
3815 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
3816 specifying @code{:mask nil}.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3817
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3818 @item :pointer @var{shape}
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3819 This specifies the pointer shape when the mouse pointer is over this
57225
27349bd528f6 Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57221
diff changeset
3820 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
3821
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3822 @item :map @var{map}
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3823 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
3824
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3825 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
3826 @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
3827 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
3828
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3829 A rectangle is a cons
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3830 @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
3831 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
3832 corners of the rectangle area.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3833
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3834 A circle is a cons
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3835 @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
3836 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
3837 be a float or integer.
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3838
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3839 A polygon is a cons
57201
2950fcfcfa44 Correct various typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57193
diff changeset
3840 @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
3841 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
3842
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3843 When the mouse pointer is above a hot-spot area of an image, the
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3844 @var{plist} of that hot-spot is consulted; if it contains a @code{help-echo}
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3845 property it defines a tool-tip for the hot-spot, and if it contains
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3846 a @code{pointer} property, it defines the shape of the mouse cursor when
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3847 it is over the hot-spot.
57225
27349bd528f6 Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 57221
diff changeset
3848 @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
3849
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
3850 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
3851 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
3852 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
3853 @var{id} is @code{area4}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3854 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3855
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3856 @defun image-mask-p spec &optional frame
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3857 @tindex image-mask-p
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3858 This function returns @code{t} if image @var{spec} has a mask bitmap.
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3859 @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
3860 @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
3861 (@pxref{Input Focus}).
33996
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3862 @end defun
d3bd47722971 image-mask-p
Dave Love <fx@gnu.org>
parents: 33373
diff changeset
3863
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3864 @node XBM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3865 @subsection XBM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3866 @cindex XBM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3867
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3868 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
3869 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
3870 always supported.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3871
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3872 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
3873
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3874 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3875 @item :foreground @var{foreground}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3876 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
3877 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
3878 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
3879 foreground color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3880
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3881 @item :background @var{background}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3882 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
3883 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
3884 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
3885 background color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3886 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3887
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3888 If you specify an XBM image using data within Emacs instead of an
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3889 external file, use the following three properties:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3890
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3891 @table @code
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3892 @item :data @var{data}
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3893 The value, @var{data}, specifies the contents of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3894 There are three formats you can use for @var{data}:
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3895
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3896 @itemize @bullet
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3897 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3898 A vector of strings or bool-vectors, each specifying one line of the
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3899 image. Do specify @code{:height} and @code{:width}.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3900
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3901 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3902 A string containing the same byte sequence as an XBM file would contain.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3903 You must not specify @code{:height} and @code{:width} in this case,
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3904 because omitting them is what indicates the data has the format of an
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3905 XBM file. The file contents specify the height and width of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3906
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3907 @item
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3908 A string or a bool-vector containing the bits of the image (plus perhaps
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3909 some extra bits at the end that will not be used). It should contain at
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3910 least @var{width} * @code{height} bits. In this case, you must specify
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3911 @code{:height} and @code{:width}, both to indicate that the string
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3912 contains just the bits rather than a whole XBM file, and to specify the
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3913 size of the image.
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3914 @end itemize
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3915
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3916 @item :width @var{width}
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3917 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
3918
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3919 @item :height @var{height}
28792
f870c858cfdf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28770
diff changeset
3920 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
3921 @end table
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 @node XPM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3924 @subsection XPM Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3925 @cindex XPM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3926
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3927 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
3928 additional image property @code{:color-symbols} is also meaningful with
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
3929 the @code{xpm} image type:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3930
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3931 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3932 @item :color-symbols @var{symbols}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3933 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
3934 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
3935 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
3936 specifies the actual color to use for displaying that name.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3937 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3938
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3939 @node GIF Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3940 @subsection GIF Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3941 @cindex GIF
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3942
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
3943 For GIF images, specify image type @code{gif}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3944
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3945 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3946 @item :index @var{index}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3947 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
3948 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
3949 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
3950 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
3951 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3952
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3953 @ignore
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3954 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
3955 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
3956 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
3957 every 0.1 seconds.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3958
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3959 (defun show-anim (file max)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3960 "Display multi-image GIF file FILE which contains MAX subimages."
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3961 (display-anim (current-buffer) file 0 max t))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3962
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3963 (defun display-anim (buffer file idx max first-time)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3964 (when (= idx max)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3965 (setq idx 0))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3966 (let ((img (create-image file nil :image idx)))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3967 (save-excursion
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3968 (set-buffer buffer)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3969 (goto-char (point-min))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3970 (unless first-time (delete-char 1))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3971 (insert-image img))
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3972 (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
3973 @end ignore
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3974
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3975 @node Postscript Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3976 @subsection Postscript Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3977 @cindex Postscript images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3978
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3979 To use Postscript for an image, specify image type @code{postscript}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3980 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
3981 these three properties:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3982
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3983 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3984 @item :pt-width @var{width}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3985 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
3986 points (1/72 inch). @var{width} must be an integer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3987
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3988 @item :pt-height @var{height}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3989 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
3990 (1/72 inch). @var{height} must be an integer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3991
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3992 @item :bounding-box @var{box}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3993 The value, @var{box}, must be a list or vector of four integers, which
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3994 specifying the bounding box of the Postscript image, analogous to the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3995 @samp{BoundingBox} comment found in Postscript files.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3996
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3997 @example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3998 %%BoundingBox: 22 171 567 738
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
3999 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4000 @end table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4001
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
4002 Displaying Postscript images from Lisp data is not currently
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
4003 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
4004 See the @file{etc/NEWS} file to make sure.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
4005
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4006 @node Other Image Types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4007 @subsection Other Image Types
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4008 @cindex PBM
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4009
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4010 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
4011 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
4012 image properties are supported.
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4013
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4014 @table @code
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4015 @item :foreground @var{foreground}
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4016 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
4017 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
4018 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
4019 foreground color.
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4020
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4021 @item :background @var{background}
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4022 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
4023 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
4024 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
4025 background color.
32552
070ca96fa546 (Other Image Types): Add description of :foreground
Gerd Moellmann <gerd@gnu.org>
parents: 32467
diff changeset
4026 @end table
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4027
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26986
diff changeset
4028 For JPEG images, specify image type @code{jpeg}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4029
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4030 For TIFF images, specify image type @code{tiff}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4031
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4032 For PNG images, specify image type @code{png}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4033
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4034 @node Defining Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4035 @subsection Defining Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4036
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4037 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
4038 @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
4039
59574
9ce057395159 (Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents: 59505
diff changeset
4040 @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
4041 @tindex create-image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4042 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
4043 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
4044 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
4045 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
4046
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4047 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
4048 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
4049 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
4050 from the file's name.
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 The remaining arguments, @var{props}, specify additional image
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4053 properties---for example,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4054
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4055 @example
59574
9ce057395159 (Defining Images): Mention DATA-P arg of create-image.
Richard M. Stallman <rms@gnu.org>
parents: 59505
diff changeset
4056 (create-image "foo.xpm" 'xpm nil :heuristic-mask t)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4057 @end example
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4058
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4059 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
4060 supported. Otherwise it returns an image descriptor.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4061 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4062
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
4063 @defmac defimage symbol specs &optional doc
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4064 @tindex defimage
41058
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
4065 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
4066 @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
4067 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
4068
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4069 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
4070 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
4071 @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
4072 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
4073 @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
4074 @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
4075 example:
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4076
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
4077 @example
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
4078 (defimage test-image
46338
6cf0fbc1d7da defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents: 46245
diff changeset
4079 ((:type xpm :file "~/test1.xpm")
6cf0fbc1d7da defimage does not evaluate SPECS.
Richard M. Stallman <rms@gnu.org>
parents: 46245
diff changeset
4080 (:type xbm :file "~/test1.xbm")))
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
4081 @end example
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4082
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4083 @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
4084 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
4085 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
4086 stored in @var{symbol}.
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
4087
3532d3226828 (Define Images): Fix the documentation of defimage. Suggested by
Eli Zaretskii <eliz@gnu.org>
parents: 40469
diff changeset
4088 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
4089 as @code{nil}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4090 @end defmac
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 @defun find-image specs
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4093 @tindex find-image
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4094 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
4095 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
4096
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4097 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
4098 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
4099 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
4100 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
4101 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
4102 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
4103 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
4104 @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
4105 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
4106
65546
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4107 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
4108 @end defun
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4109
65546
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4110 @defvar image-load-path
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4111 @tindex image-load-path
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4112 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
4113 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
4114 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
4115 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
4116 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
4117
65560
9007bcbba781 (Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents: 65546
diff changeset
4118 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
4119 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
4120 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
4121 @code{load-path}. Subdirectories are not automatically included in
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4122 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
4123 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
4124 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
4125 should specify the image as follows:
65546
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4126
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4127 @example
65560
9007bcbba781 (Defining Images): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents: 65546
diff changeset
4128 (defimage foo-image '((:type xpm :file "foo/bar.xpm")))
65546
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4129 @end example
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4130 @end defvar
6759056e7603 Document `image-load-path'.
Chong Yidong <cyd@stupidchicken.com>
parents: 65369
diff changeset
4131
69418
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4132 @defun image-load-path-for-library library image &optional path no-error
69421
a8284aa5c2b4 (Defining Images): Add @tindex for image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69418
diff changeset
4133 @tindex image-load-path-for-library
69521
3a3fa8d383e2 (Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 69517
diff changeset
4134 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
4135 Lisp package @var{library}.
3a3fa8d383e2 (Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 69517
diff changeset
4136
3a3fa8d383e2 (Defining Images): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 69517
diff changeset
4137 It searches for @var{image} in @code{image-load-path} (excluding
69517
a1a937e48976 (Defining Images): In image-load-path-for-library, prefer user's
Bill Wohler <wohler@newt.com>
parents: 69494
diff changeset
4138 @file{@code{data-directory}/images}) and @code{load-path}, followed by
a1a937e48976 (Defining Images): In image-load-path-for-library, prefer user's
Bill Wohler <wohler@newt.com>
parents: 69494
diff changeset
4139 a path suitable for @var{library}, which includes
a1a937e48976 (Defining Images): In image-load-path-for-library, prefer user's
Bill Wohler <wohler@newt.com>
parents: 69494
diff changeset
4140 @file{../../etc/images} and @file{../etc/images} relative to the
a1a937e48976 (Defining Images): In image-load-path-for-library, prefer user's
Bill Wohler <wohler@newt.com>
parents: 69494
diff changeset
4141 library file itself, and then in @file{@code{data-directory}/images}.
69462
831f4f793f95 (Invisible Text): The impossible position is
Richard M. Stallman <rms@gnu.org>
parents: 69421
diff changeset
4142
69464
68172dbc9679 (Defining Images): Clean up last change.
Richard M. Stallman <rms@gnu.org>
parents: 69462
diff changeset
4143 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
4144 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
4145 @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
4146 @code{load-path}.
279f737753d8 (Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents: 69464
diff changeset
4147
279f737753d8 (Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents: 69464
diff changeset
4148 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
4149 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
4150 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
4151
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4152 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
4153 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
4154
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4155 @example
69494
a996c2fa0b6a (Defining Images): Fix example in image-load-path-for-library by not
Bill Wohler <wohler@newt.com>
parents: 69473
diff changeset
4156 ;; Shush compiler.
a996c2fa0b6a (Defining Images): Fix example in image-load-path-for-library by not
Bill Wohler <wohler@newt.com>
parents: 69473
diff changeset
4157 (defvar image-load-path)
69473
279f737753d8 (Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents: 69464
diff changeset
4158
279f737753d8 (Defining Images): In image-load-path-for-library, always return list
Bill Wohler <wohler@newt.com>
parents: 69464
diff changeset
4159 (let* ((load-path (image-load-path-for-library "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
4160 (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
4161 (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
4162 image-load-path))))
69418
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4163 (mh-tool-bar-folder-buttons-init))
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4164 @end example
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4165 @end defun
2f43ac9fe122 (Defining Images): Add image-load-path-for-library.
Bill Wohler <wohler@newt.com>
parents: 69067
diff changeset
4166
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4167 @node Showing Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4168 @subsection Showing Images
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4169
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4170 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
4171 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
4172 section.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4173
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
4174 @defun insert-image image &optional string area slice
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4175 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
4176 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
4177 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
4178 @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
4179 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
4180 @code{insert-image} uses @code{" "} by default.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4181
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4182 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
4183 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
4184 @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
4185 @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
4186 buffer's text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4187
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
4188 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
4189 @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
4190 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
4191 @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
4192 @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
4193 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
4194 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
4195 image.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
4196
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
4197 Internally, this function inserts @var{string} in the buffer, and gives
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
4198 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
4199 Property}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4200 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4201
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
4202 @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
4203 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
4204 @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
4205 equally sized slices.
57193
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
4206 @end defun
714a83d1ea32 (Display): Add 'Fringe Bitmaps' and 'Pointer
Kim F. Storm <storm@cua.dk>
parents: 56451
diff changeset
4207
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
4208 @defun put-image image pos &optional string area
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4209 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
4210 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
4211 marker. It specifies the buffer position where the image should appear.
29471
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
4212 The argument @var{string} specifies the text that should hold the image
215b57502518 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 29151
diff changeset
4213 as an alternative to the default.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4214
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4215 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
4216 by @code{create-image} or stored by @code{defimage}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4217
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4218 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
4219 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
4220 @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
4221 @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
4222 buffer's text.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4223
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4224 Internally, this function creates an overlay, and gives it a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4225 @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
4226 property whose value is the image. (Whew!)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4227 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4228
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4229 @defun remove-images start end &optional buffer
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4230 This function removes images in @var{buffer} between positions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4231 @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
4232 images are removed from the current buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4233
27331
be0a552c8320 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27193
diff changeset
4234 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
4235 @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
4236 @code{insert-image} or in other ways.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4237 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4238
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4239 @defun image-size spec &optional pixels frame
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4240 @tindex image-size
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4241 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
4242 @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
4243 specification. @var{pixels} non-@code{nil} means return sizes
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
4244 measured in pixels, otherwise return sizes measured in canonical
55fb0658914a Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 51000
diff changeset
4245 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
4246 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
4247 @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
4248 Focus}).
31373
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4249 @end defun
a3fd71daf442 help-echo stuff, find-image, image-size.
Dave Love <fx@gnu.org>
parents: 29471
diff changeset
4250
66197
53c764d16ccf * display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents: 66143
diff changeset
4251 @defvar max-image-size
53c764d16ccf * display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents: 66143
diff changeset
4252 @tindex max-image-size
53c764d16ccf * display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents: 66143
diff changeset
4253 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
4254 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
4255 larger than this limit.
97afbe22dea4 (Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents: 66197
diff changeset
4256
97afbe22dea4 (Showing Images): Add max-image-size integer value.
Kim F. Storm <storm@cua.dk>
parents: 66197
diff changeset
4257 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
4258 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
4259 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
4260 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
4261 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
4262
53c764d16ccf * display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents: 66143
diff changeset
4263 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
4264 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
4265 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
4266 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
4267 @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
4268 @end defvar
53c764d16ccf * display.texi (Showing Images): Document max-image-size.
Chong Yidong <cyd@stupidchicken.com>
parents: 66143
diff changeset
4269
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4270 @node Image Cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4271 @subsection Image Cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4272
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4273 Emacs stores images in an image cache when it displays them, so it can
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4274 display them again more efficiently. It removes an image from the cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4275 when it hasn't been displayed for a specified period of time.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4276
28770
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
4277 When an image is looked up in the cache, its specification is compared
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
4278 with cached image specifications using @code{equal}. This means that
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
4279 all images with equal specifications share the same image in the cache.
313b9e6e2dbf *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 27971
diff changeset
4280
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4281 @defvar image-cache-eviction-delay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4282 @tindex image-cache-eviction-delay
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4283 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
4284 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
4285 length of time, Emacs removes it from the image cache.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4286
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4287 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
4288 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
4289 debugging.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4290 @end defvar
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4291
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4292 @defun clear-image-cache &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4293 @tindex clear-image-cache
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4294 This function clears the image cache. If @var{frame} is non-@code{nil},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4295 only the cache for that frame is cleared. Otherwise all frames' caches
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4296 are cleared.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4297 @end defun
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
4298
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4299 @node Buttons
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4300 @section Buttons
53468
f641b341c5ec Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents: 53467
diff changeset
4301 @cindex buttons
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4302 @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
4303 @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
4304
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4305 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
4306 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
4307 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
4308 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
4309
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4310 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
4311 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
4312 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
4313
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4314 One of the these properties (@code{action}) is a function, which will
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4315 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
4316 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
4317 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
4318
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4319 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
4320 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
4321 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
4322 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
4323 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
4324 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
4325 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
4326 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
4327 entries).
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4328
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4329 @menu
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4330 * 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
4331 * Button Types:: Defining common properties for classes of buttons.
55246
33248295ffc4 emacs -> Emacs.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
4332 * 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
4333 * 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
4334 * 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
4335 @end menu
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4336
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4337 @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
4338 @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
4339 @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
4340
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4341 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
4342 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
4343 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
4344 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
4345
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4346 @table @code
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4347 @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
4348 @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
4349 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
4350 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
4351 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
4352
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4353 @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
4354 @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
4355 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
4356 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
4357 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
4358 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
4359
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4360 @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
4361 @kindex face @r{(button property)}
55246
33248295ffc4 emacs -> Emacs.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
4362 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
4363 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
4364
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4365 @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
4366 @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
4367 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
4368 mouse-overs (merged with the usual button face); by default this is
55246
33248295ffc4 emacs -> Emacs.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
4369 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
4370
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4371 @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
4372 @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
4373 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
4374 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
4375 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
4376 @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
4377
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4378 @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
4379 @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
4380 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
4381 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
4382 @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
4383
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4384 @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
4385 @kindex help-index @r{(button property)}
55246
33248295ffc4 emacs -> Emacs.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
4386 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
4387 @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
4388
59467
9c3931bf6cd0 (Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents: 59463
diff changeset
4389 @item follow-link
9c3931bf6cd0 (Button Properties): Add follow-link keyword.
Kim F. Storm <storm@cua.dk>
parents: 59463
diff changeset
4390 @kindex follow-link @r{(button property)}
59505
19b4e3d63aed (Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents: 59493
diff changeset
4391 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
4392 on this button, @xref{Links and Mouse-1}.
19b4e3d63aed (Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents: 59493
diff changeset
4393
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4394 @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
4395 @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
4396 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
4397 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
4398 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
4399 @end table
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4400
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4401 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
4402 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
4403
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4404 @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
4405 @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
4406 @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
4407
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4408 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
4409 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
4410 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
4411 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
4412 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
4413
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4414 @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
4415 @tindex define-button-type
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4416 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
4417 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
4418 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
4419 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
4420 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
4421
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4422 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
4423 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
4424 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
4425 @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
4426 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
4427 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4428
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4429 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
4430 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
4431 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
4432 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
4433
f641b341c5ec Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents: 53467
diff changeset
4434 @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
4435 @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
4436 @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
4437
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4438 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
4439 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
4440 initialized from the button's type (which defaults to the built-in
55246
33248295ffc4 emacs -> Emacs.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
4441 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
4442 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
4443 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
4444 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
4445
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4446 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
4447 those that add button properties to an existing region of a buffer,
68084
9b969687ff7c Fix typos.
Eli Zaretskii <eliz@gnu.org>
parents: 67047
diff changeset
4448 called @code{make-...button}, and those that also insert the button
9b969687ff7c Fix typos.
Eli Zaretskii <eliz@gnu.org>
parents: 67047
diff changeset
4449 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
4450
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4451 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
4452 @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
4453 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
4454 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
4455 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
4456 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
4457 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
4458 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
4459
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4460 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
4461 (@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
4462
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4463 @defun make-button beg end &rest properties
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4464 @tindex make-button
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4465 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
4466 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
4467 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4468
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4469 @defun insert-button label &rest properties
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4470 @tindex insert-button
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4471 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
4472 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
4473 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4474
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4475 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
4476 (@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
4477 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
4478 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
4479 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
4480 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
4481 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
4482
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4483 @defun make-text-button beg end &rest properties
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4484 @tindex make-text-button
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4485 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
4486 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
4487 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4488
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4489 @defun insert-text-button label &rest properties
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4490 @tindex insert-text-button
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4491 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
4492 properties.
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4493 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4494
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4495 @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
4496 @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
4497 @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
4498
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4499 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
4500 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
4501 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
4502
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4503 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
4504 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
4505 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
4506 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
4507 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
4508
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4509 @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
4510 @tindex button-start
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4511 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
4512 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4513
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4514 @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
4515 @tindex button-end
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4516 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
4517 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4518
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4519 @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
4520 @tindex button-get
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4521 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
4522 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4523
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4524 @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
4525 @tindex button-put
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4526 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
4527 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4528
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4529 @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
4530 @tindex button-activate
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4531 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
4532 @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
4533 @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
4534 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
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 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
4538 @tindex button-label
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4539 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
4540 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4541
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4542 @defun button-type button
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4543 @tindex button-type
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4544 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
4545 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4546
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4547 @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
4548 @tindex button-has-type-p
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4549 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
4550 @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
4551 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4552
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4553 @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
4554 @tindex button-at
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4555 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
4556 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4557
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4558 @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
4559 @tindex button-type-put
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4560 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
4561 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4562
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4563 @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
4564 @tindex button-type-get
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4565 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
4566 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4567
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4568 @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
4569 @tindex button-type-subtype-p
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4570 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
4571 @end defun
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4572
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4573 @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
4574 @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
4575 @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
4576
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4577 These are commands and functions for locating and operating on
55246
33248295ffc4 emacs -> Emacs.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
4578 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
4579
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4580 @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
4581 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
4582 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
4583 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
4584 @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
4585 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
4586 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
4587 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
4588
59505
19b4e3d63aed (Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents: 59493
diff changeset
4589 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
4590 @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
4591 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
4592 @xref{Links and Mouse-1}.
59505
19b4e3d63aed (Button Properties, Button Buffer Commands):
Kim F. Storm <storm@cua.dk>
parents: 59493
diff changeset
4593
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4594 @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
4595 @tindex push-button
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4596 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
4597 @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
4598 @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
4599 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
4600 @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
4601 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
4602 @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
4603 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
4604 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
4605 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
4606 @end deffn
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4607
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4608 @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
4609 @tindex forward-button
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4610 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
4611 @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
4612 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
4613 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
4614 @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
4615 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
4616 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
4617 @end deffn
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4618
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4619 @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
4620 @tindex backward-button
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4621 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
4622 @var{n} is negative. If @var{n} is zero, move to the start of any
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4623 button at point. If @var{wrap} is non-@code{nil}, moving past either
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4624 end of the buffer continues from the other end. If
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4625 @var{display-message} is non-@code{nil}, the button's help-echo string
53468
f641b341c5ec Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents: 53467
diff changeset
4626 is displayed. Any button with a non-@code{nil} @code{skip} property
f641b341c5ec Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-13
Miles Bader <miles@gnu.org>
parents: 53467
diff changeset
4627 is skipped over. Returns the button found.
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4628 @end deffn
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4629
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4630 @defun next-button pos &optional count-current
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4631 @tindex next-button
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4632 Return the next button after position @var{pos} in the current buffer.
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4633 If @var{count-current} is non-@code{nil}, count any button at
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4634 @var{pos} in the search, instead of starting at the next button.
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4635 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4636
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4637 @defun previous-button pos &optional count-current
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4638 @tindex previous-button
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4639 Return the @var{n}th button before position @var{pos} in the current
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4640 buffer. If @var{count-current} is non-@code{nil}, count any button at
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4641 @var{pos} in the search, instead of starting at the next button.
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4642 @end defun
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4643
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4644 @node Blinking
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4645 @section Blinking Parentheses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4646 @cindex parenthesis matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4647 @cindex blinking
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4648 @cindex balancing parentheses
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4649 @cindex close parenthesis
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4650
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4651 This section describes the mechanism by which Emacs shows a matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4652 open parenthesis when the user inserts a close parenthesis.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4653
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4654 @defvar blink-paren-function
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4655 The value of this variable should be a function (of no arguments) to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4656 be called whenever a character with close parenthesis syntax is inserted.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4657 The value of @code{blink-paren-function} may be @code{nil}, in which
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4658 case nothing is done.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4659 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4660
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4661 @defopt blink-matching-paren
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4662 If this variable is @code{nil}, then @code{blink-matching-open} does
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4663 nothing.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4664 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4665
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4666 @defopt blink-matching-paren-distance
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4667 This variable specifies the maximum distance to scan for a matching
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4668 parenthesis before giving up.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4669 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4670
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4671 @defopt blink-matching-delay
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
4672 This variable specifies the number of seconds for the cursor to remain
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
4673 at the matching parenthesis. A fraction of a second often gives
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
4674 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
4675 @end defopt
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
4676
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4677 @deffn Command blink-matching-open
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4678 This function is the default value of @code{blink-paren-function}. It
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4679 assumes that point follows a character with close parenthesis syntax and
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4680 moves the cursor momentarily to the matching opening character. If that
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4681 character is not already on the screen, it displays the character's
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4682 context in the echo area. To avoid long delays, this function does not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4683 search farther than @code{blink-matching-paren-distance} characters.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4684
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4685 Here is an example of calling this function explicitly.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4686
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4687 @smallexample
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4688 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4689 (defun interactive-blink-matching-open ()
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4690 @c Do not break this line! -- rms.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4691 @c The first line of a doc string
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4692 @c must stand alone.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4693 "Indicate momentarily the start of sexp before point."
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4694 (interactive)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4695 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4696 @group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4697 (let ((blink-matching-paren-distance
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4698 (buffer-size))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4699 (blink-matching-paren t))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4700 (blink-matching-open)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4701 @end group
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4702 @end smallexample
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4703 @end deffn
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4704
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4705 @node Usual Display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4706 @section Usual Display Conventions
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4707
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4708 The usual display conventions define how to display each character
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4709 code. You can override these conventions by setting up a display table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4710 (@pxref{Display Tables}). Here are the usual display conventions:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4711
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4712 @itemize @bullet
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4713 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4714 Character codes 32 through 126 map to glyph codes 32 through 126.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4715 Normally this means they display as themselves.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4716
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4717 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4718 Character code 9 is a horizontal tab. It displays as whitespace
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4719 up to a position determined by @code{tab-width}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4720
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4721 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4722 Character code 10 is a newline.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4723
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4724 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4725 All other codes in the range 0 through 31, and code 127, display in one
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8925
diff changeset
4726 of two ways according to the value of @code{ctl-arrow}. If it is
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4727 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
4728 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4729 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4730 just like the codes in the range 128 to 255.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4731
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4732 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
4733 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
4734 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
4735 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
4736 emacs, The GNU Emacs Manual}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4737
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4738 @item
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4739 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
4740 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
4741 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
4742 table can specify a glyph to use instead of @samp{\}.)
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
4743
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
4744 @item
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
4745 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
4746 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
4747 character.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4748 @end itemize
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4749
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4750 The usual display conventions apply even when there is a display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4751 table, for any character whose entry in the active display table is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4752 @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
4753 specify the characters for which you want special behavior.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4754
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
4755 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
4756 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
4757 buffer where you expect it, if it was eliminated as part of end-of-line
25454
80ac191b6d2b *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24951
diff changeset
4758 conversion (@pxref{Coding System Basics}).
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
4759
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4760 These variables affect the way certain characters are displayed on the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4761 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
4762 they also affect the indentation functions. These variables also affect
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4763 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
4764 mode line using the new values, call the function
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4765 @code{force-mode-line-update} (@pxref{Mode Line Format}).
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4766
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4767 @defopt ctl-arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4768 @cindex control characters in display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4769 This buffer-local variable controls how control characters are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4770 displayed. If it is non-@code{nil}, they are displayed as a caret
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4771 followed by the character: @samp{^A}. If it is @code{nil}, they are
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4772 displayed as a backslash followed by three octal digits: @samp{\001}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4773 @end defopt
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4774
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4775 @c Following may have overfull hbox.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4776 @defvar default-ctl-arrow
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4777 The value of this variable is the default value for @code{ctl-arrow} in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4778 buffers that do not override it. @xref{Default Value}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4779 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4780
58496
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
4781 @defopt tab-width
65369
822218f80ae4 2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents: 65121
diff changeset
4782 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
4783 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
4784 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
4785 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
4786 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
4787 @end defopt
c6040c1274b7 (Customizing Bitmaps): Move indicate-buffer-boundaries
Richard M. Stallman <rms@gnu.org>
parents: 58371
diff changeset
4788
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4789 @node Display Tables
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4790 @section Display Tables
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4791
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4792 @cindex display table
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
4793 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
4794 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
4795 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
4796 set.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4797
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4798 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
4799 @dfn{glyphs}, each glyph being a graphic that takes up one character
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4800 position on the screen. You can also define how to display each glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4801 on your terminal, using the @dfn{glyph table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4802
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4803 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
4804 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
4805 @code{force-mode-line-update} (@pxref{Mode Line Format}).
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4806
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4807 @menu
53467
a18219fcd84d Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-12
Miles Bader <miles@gnu.org>
parents: 53422
diff changeset
4808 * 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
4809 * 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
4810 * Glyphs:: How to define a glyph, and what glyphs mean.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4811 @end menu
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4812
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4813 @node Display Table Format
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4814 @subsection Display Table Format
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4815
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
4816 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
4817 @code{display-table} as its subtype.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4818
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4819 @defun make-display-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4820 This creates and returns a display table. The table initially has
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4821 @code{nil} in all elements.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4822 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4823
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4824 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
4825 codes; the element at index @var{c} says how to display the character
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4826 code @var{c}. The value should be @code{nil} or a vector of glyph
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4827 values (@pxref{Glyphs}). If an element is @code{nil}, it says to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4828 display that character according to the usual display conventions
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4829 (@pxref{Usual Display}).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
4830
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
4831 If you use the display table to change the display of newline
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10211
diff changeset
4832 characters, the whole buffer will be displayed as one long ``line.''
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4833
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4834 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
4835 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
4836 means to use the default for that slot, as stated below.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4837
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4838 @table @asis
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4839 @item 0
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4840 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
4841 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
4842 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
4843 no effect.
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4844
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4845 @item 1
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4846 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
4847 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
4848 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
4849
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4850 @item 2
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4851 The glyph for indicating a character displayed as an octal character
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4852 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
4853
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4854 @item 3
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4855 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
4856
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4857 @item 4
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4858 A vector of glyphs for indicating the presence of invisible lines (the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4859 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
4860
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4861 @item 5
8925
b05788fd41f0 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 8096
diff changeset
4862 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
4863 default is @samp{|}). @xref{Splitting Windows}. This takes effect only
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4864 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
4865 a scroll bar separates the two windows.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4866 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4867
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4868 For example, here is how to construct a display table that mimics the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4869 effect of setting @code{ctl-arrow} to a non-@code{nil} value:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4870
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4871 @example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4872 (setq disptab (make-display-table))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4873 (let ((i 0))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4874 (while (< i 32)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4875 (or (= i ?\t) (= i ?\n)
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4876 (aset disptab i (vector ?^ (+ i 64))))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4877 (setq i (1+ i)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4878 (aset disptab 127 (vector ?^ ??)))
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4879 @end example
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4880
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
4881 @defun display-table-slot display-table slot
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4882 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
4883 @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
4884 5 inclusive, or a slot name (symbol). Valid symbols are
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4885 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4886 @code{selective-display}, and @code{vertical-border}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4887 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4888
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
4889 @defun set-display-table-slot display-table slot value
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4890 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
4891 @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
4892 5 inclusive, or a slot name (symbol). Valid symbols are
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4893 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4894 @code{selective-display}, and @code{vertical-border}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4895 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4896
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4897 @defun describe-display-table display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4898 @tindex describe-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4899 This function displays a description of the display table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4900 @var{display-table} in a help buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4901 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4902
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4903 @deffn Command describe-current-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4904 @tindex describe-current-display-table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4905 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
4906 help buffer.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4907 @end deffn
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4908
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4909 @node Active Display Table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4910 @subsection Active Display Table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4911 @cindex active display table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4912
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4913 Each window can specify a display table, and so can each buffer. When
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4914 a buffer @var{b} is displayed in window @var{w}, display uses the
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4915 display table for window @var{w} if it has one; otherwise, the display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4916 table for buffer @var{b} if it has one; otherwise, the standard display
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4917 table if any. The display table chosen is called the @dfn{active}
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4918 display table.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4919
60503
ed1869261935 (Overlay Arrow, Fringe Bitmaps, Customizing Bitmaps): Now subnodes of Fringes.
Richard M. Stallman <rms@gnu.org>
parents: 60442
diff changeset
4920 @defun window-display-table &optional window
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4921 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
4922 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
4923 for @var{window} is the selected window.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4924 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4925
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4926 @defun set-window-display-table window table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4927 This function sets the display table of @var{window} to @var{table}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4928 The argument @var{table} should be either a display table or
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4929 @code{nil}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4930 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4931
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4932 @defvar buffer-display-table
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
4933 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
4934 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
4935 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
4936 table.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4937 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4938
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4939 @defvar standard-display-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4940 This variable's value is the default display table, used whenever a
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4941 window has no display table and neither does the buffer displayed in
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4942 that window. This variable is @code{nil} by default.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4943 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4944
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4945 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
4946 if the window specifies none, its buffer specifies none, and
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
4947 @code{standard-display-table} is @code{nil}---then Emacs uses the usual
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4948 display conventions for all character codes in that window. @xref{Usual
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4949 Display}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4950
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4951 A number of functions for changing the standard display table
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4952 are defined in the library @file{disp-table}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
4953
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4954 @node Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4955 @subsection Glyphs
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4956
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4957 @cindex glyph
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4958 A @dfn{glyph} is a generalization of a character; it stands for an
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4959 image that takes up a single character position on the screen. Glyphs
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4960 are represented in Lisp as integers, just as characters are. Normally
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4961 Emacs finds glyphs in the display table (@pxref{Display Tables}).
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4962
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4963 A glyph can be @dfn{simple} or it can be defined by the @dfn{glyph
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4964 table}. A simple glyph is just a way of specifying a character and a
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4965 face to output it in. The glyph code for a simple glyph, mod 524288,
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4966 is the character to output, and the glyph code divided by 524288
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4967 specifies the face number (@pxref{Face Functions}) to use while
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4968 outputting it. (524288 is
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4969 @ifnottex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4970 2**19.)
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4971 @end ifnottex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4972 @tex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4973 $2^{19}$.)
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4974 @end tex
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4975 @xref{Faces}.
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4976
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4977 On character terminals, you can set up a @dfn{glyph table} to define
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4978 the meaning of glyph codes. The glyph codes is the value of the
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4979 variable @code{glyph-table}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4980
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4981 @defvar glyph-table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4982 The value of this variable is the current glyph table. It should be a
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48948
diff changeset
4983 vector; the @var{g}th element defines glyph code @var{g}.
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4984
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4985 If a glyph code is greater than or equal to the length of the glyph
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4986 table, that code is automatically simple. If the value of
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4987 @code{glyph-table} is @code{nil} instead of a vector, then all glyphs
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4988 are simple. The glyph table is not used on graphical displays, only
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
4989 on character terminals. On graphical displays, all glyphs are simple.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4990 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4991
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4992 Here are the possible types of elements in the glyph table:
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4993
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4994 @table @asis
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
4995 @item @var{string}
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4996 Send the characters in @var{string} to the terminal to output
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4997 this glyph. This alternative is available on character terminals,
68708
c0833efdd110 "Graphical display", not window system.
Richard M. Stallman <rms@gnu.org>
parents: 68648
diff changeset
4998 but not on graphical displays.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4999
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5000 @item @var{integer}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
5001 Define this glyph code as an alias for glyph code @var{integer}. You
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
5002 can use an alias to specify a face code for the glyph and use a small
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
5003 number as its code.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5004
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5005 @item @code{nil}
47482
aabdbec10b60 Correct the explanation of glyphs and glyph table.
Richard M. Stallman <rms@gnu.org>
parents: 46721
diff changeset
5006 This glyph is simple.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5007 @end table
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5008
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5009 @defun create-glyph string
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5010 @tindex create-glyph
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5011 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
5012 display by sending @var{string} to the terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5013 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5014
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5015 @node Beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5016 @section Beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5017 @cindex beeping
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5018 @cindex bell
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5019
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
5020 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
5021 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
5022 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
5023 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
5024 appropriate. (@xref{Errors}.)
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5025
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
5026 @defun ding &optional do-not-terminate
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5027 @cindex keyboard macro termination
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5028 This function beeps, or flashes the screen (see @code{visible-bell} below).
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5029 It also terminates any keyboard macro currently executing unless
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
5030 @var{do-not-terminate} is non-@code{nil}.
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5031 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5032
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
5033 @defun beep &optional do-not-terminate
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5034 This is a synonym for @code{ding}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5035 @end defun
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5036
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5037 @defopt visible-bell
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5038 This variable determines whether Emacs should flash the screen to
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5039 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
5040 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
5041 provided the terminal's Termcap entry defines the visible bell
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
5042 capability (@samp{vb}).
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5043 @end defopt
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5044
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
5045 @defvar ring-bell-function
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
5046 If this is non-@code{nil}, it specifies how Emacs should ``ring the
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
5047 bell.'' Its value should be a function of no arguments. If this is
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
5048 non-@code{nil}, it takes precedence over the @code{visible-bell}
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
5049 variable.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
5050 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
5051
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5052 @node Window Systems
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5053 @section Window Systems
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5054
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5055 Emacs works with several window systems, most notably the X Window
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5056 System. Both Emacs and X use the term ``window'', but use it
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5057 differently. An Emacs frame is a single window as far as X is
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5058 concerned; the individual Emacs windows are not known to X at all.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5059
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5060 @defvar window-system
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5061 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
5062 under. The possible values are
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5063
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5064 @table @code
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5065 @item x
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5066 @cindex X Window System
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5067 Emacs is displaying using X.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5068 @item pc
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5069 Emacs is displaying using MS-DOS.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5070 @item w32
27332
5cfe77eaff45 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27331
diff changeset
5071 Emacs is displaying using Windows.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5072 @item mac
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 25454
diff changeset
5073 Emacs is displaying using a Macintosh.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5074 @item nil
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5075 Emacs is using a character-based terminal.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
5076 @end table
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5077 @end defvar
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5078
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5079 @defvar window-setup-hook
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 18234
diff changeset
5080 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
5081 initialization files. Emacs runs this hook after it has completed
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25809
diff changeset
5082 loading your init file, the default initialization file (if
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
5083 any), and the terminal-specific Lisp code, and running the hook
6598
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5084 @code{term-setup-hook}.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5085
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5086 This hook is used for internal purposes: setting up communication with
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5087 the window system, and creating the initial window. Users should not
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5088 interfere with it.
db2685239be9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5089 @end defvar
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
5090
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
5091 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
5092 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52380
diff changeset
5093 @end ignore