annotate doc/lispref/display.texi @ 104499:d0cdad3e21eb

test/cedet/ede-tests.el: New file.
author Chong Yidong <cyd@stupidchicken.com>
date Sun, 20 Sep 2009 21:07:22 +0000
parents a21bb1c0cb0e
children c72e3dd88ed4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001,
103820
9e06f7e38c79 (Abstract Display): Merge in some menu descriptions from elisp.texi.
Glenn Morris <rgm@gnu.org>
parents: 103586
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
9e06f7e38c79 (Abstract Display): Merge in some menu descriptions from elisp.texi.
Glenn Morris <rgm@gnu.org>
parents: 103586
diff changeset
5 @c Free Software Foundation, Inc.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84060
diff changeset
7 @setfilename ../../info/display
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @node Display, System Interface, Processes, Top
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @chapter Emacs Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 This chapter describes a number of features related to the display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 that Emacs presents to the user.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 * Refresh Screen:: Clearing the screen and redrawing everything on it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 * Forcing Redisplay:: Forcing redisplay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 * Truncation:: Folding or wrapping long text lines.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 * The Echo Area:: Displaying messages at the bottom of the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 * Warnings:: Displaying warning messages for the user.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 * Invisible Text:: Hiding part of the buffer text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 * Selective Display:: Hiding part of the buffer text (the old way).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 * Temporary Displays:: Displays that go away automatically.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 * Overlays:: Use overlays to highlight parts of the buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 * Width:: How wide a character or string is on the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 * Line Height:: Controlling the height of lines.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 * Faces:: A face defines a graphics style for text characters:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 font, colors, etc.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 * Fringes:: Controlling window fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 * Scroll Bars:: Controlling vertical scroll bars.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 * Display Property:: Enabling special display features.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 * Images:: Displaying images in Emacs buffers.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 * Buttons:: Adding clickable buttons to Emacs buffers.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 * Abstract Display:: Emacs' Widget for Object Collections.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 * Blinking:: How Emacs shows the matching open parenthesis.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 * Usual Display:: The usual conventions for displaying nonprinting chars.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 * Display Tables:: How to specify other conventions.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 * Beeping:: Audible signal to the user.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 * Window Systems:: Which window system is being used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 @node Refresh Screen
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 @section Refreshing the Screen
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 The function @code{redraw-frame} clears and redisplays the entire
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 contents of a given frame (@pxref{Frames}). This is useful if the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 screen is corrupted.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 @c Emacs 19 feature
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 @defun redraw-frame frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 This function clears and redisplays frame @var{frame}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 Even more powerful is @code{redraw-display}:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 @deffn Command redraw-display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 This function clears and redisplays all visible frames.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 @end deffn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58
87098
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
59 In Emacs, processing user input takes priority over redisplay. If
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
60 you call these functions when input is available, they don't redisplay
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
61 immediately, but the requested redisplay does happen
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
62 eventually---after all the input has been processed.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
64 On text-only terminals, suspending and resuming Emacs normally also
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
65 refreshes the screen. Some terminal emulators record separate
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
66 contents for display-oriented programs such as Emacs and for ordinary
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
67 sequential display. If you are using such a terminal, you might want
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
68 to inhibit the redisplay on resumption.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
70 @defopt no-redraw-on-reenter
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 @cindex suspend (cf. @code{no-redraw-on-reenter})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 @cindex resume (cf. @code{no-redraw-on-reenter})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 This variable controls whether Emacs redraws the entire screen after it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 has been suspended and resumed. Non-@code{nil} means there is no need
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 to redraw, @code{nil} means redrawing is needed. The default is @code{nil}.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
76 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 @node Forcing Redisplay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 @section Forcing Redisplay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 @cindex forcing redisplay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81
87098
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
82 Emacs normally tries to redisplay the screen whenever it waits for
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
83 input. With the following function, you can request an immediate
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
84 attempt to redisplay, in the middle of Lisp code, without actually
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
85 waiting for input.
87098
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
86
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
87 @defun redisplay &optional force
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
88 This function tries immediately to redisplay, provided there are no
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
89 pending input events.
87098
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
90
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
91 If the optional argument @var{force} is non-@code{nil}, it does all
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
92 pending redisplay work even if input is available, with no
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
93 pre-emption.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
94
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
95 The function returns @code{t} if it actually tried to redisplay, and
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
96 @code{nil} otherwise. A value of @code{t} does not mean that
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
97 redisplay proceeded to completion; it could have been pre-empted by
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
98 newly arriving terminal input.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
99 @end defun
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
100
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
101 @code{redisplay} with no argument tries immediately to redisplay,
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
102 but has no effect on the usual rules for what parts of the screen to
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
103 redisplay. By contrast, the following function adds certain windows
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
104 to the pending redisplay work (as if their contents had completely
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
105 changed), but doesn't immediately try to do any redisplay work.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
106
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
107 @defun force-window-update &optional object
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
108 This function forces some or all windows to be updated on next
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
109 redisplay. If @var{object} is a window, it requires eventual
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
110 redisplay of that window. If @var{object} is a buffer or buffer name,
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
111 it requires eventual redisplay of all windows displaying that buffer.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
112 If @var{object} is @code{nil} (or omitted), it requires eventual
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
113 redisplay of all windows.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
114 @end defun
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
115
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
116 @code{force-window-update} does not do a redisplay immediately.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
117 (Emacs will do that when it waits for input.) Rather, its effect is
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
118 to put more work on the queue to be done by redisplay whenever there
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
119 is a chance.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
120
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 Emacs redisplay normally stops if input arrives, and does not happen
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 at all if input is available before it starts. Most of the time, this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 is exactly what you want. However, you can prevent preemption by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 binding @code{redisplay-dont-pause} to a non-@code{nil} value.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125
87098
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
126 @defvar redisplay-dont-pause
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
127 If this variable is non-@code{nil}, pending input does not
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
128 prevent or halt redisplay; redisplay occurs, and finishes,
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
129 regardless of whether input is available.
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
130 @end defvar
ec0ef12211d9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85311
diff changeset
131
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 @defvar redisplay-preemption-period
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 This variable specifies how many seconds Emacs waits between checks
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 for new input during redisplay. (The default is 0.1 seconds.) If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 input has arrived when Emacs checks, it pre-empts redisplay and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 processes the available input before trying again to redisplay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 If this variable is @code{nil}, Emacs does not check for input during
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 redisplay, and redisplay cannot be preempted by input.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 This variable is only obeyed on graphical terminals. For
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 text terminals, see @ref{Terminal Output}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @node Truncation
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @section Truncation
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @cindex line wrapping
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 @cindex line truncation
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @cindex continuation lines
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 @cindex @samp{$} in display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @cindex @samp{\} in display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 When a line of text extends beyond the right edge of a window, Emacs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 can @dfn{continue} the line (make it ``wrap'' to the next screen
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 line), or @dfn{truncate} the line (limit it to one screen line). The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 additional screen lines used to display a long text line are called
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 @dfn{continuation} lines. Continuation is not the same as filling;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 continuation happens on the screen only, not in the buffer contents,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 and it breaks a line precisely at the right margin, not at a word
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 boundary. @xref{Filling}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 On a graphical display, tiny arrow images in the window fringes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 indicate truncated and continued lines (@pxref{Fringes}). On a text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 terminal, a @samp{$} in the rightmost column of the window indicates
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 truncation; a @samp{\} on the rightmost column indicates a line that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 ``wraps.'' (The display table can specify alternate characters to use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 for this; @pxref{Display Tables}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 @defopt truncate-lines
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
170 If this buffer-local variable is non-@code{nil}, lines that extend
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
171 beyond the right edge of the window are truncated; otherwise, they are
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
172 continued. As a special exception, the variable
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
173 @code{truncate-partial-width-windows} takes precedence in
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
174 @dfn{partial-width} windows (i.e., windows that do not occupy the
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
175 entire frame width).
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 @defopt default-truncate-lines
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 This variable is the default value for @code{truncate-lines}, for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 buffers that do not have buffer-local values for it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @defopt truncate-partial-width-windows
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
184 This variable controls line truncation in @dfn{partial-width} windows.
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
185 A partial-width window is one that does not occupy the entire frame
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
186 width (@pxref{Splitting Windows}). If the value is @code{nil}, line
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
187 truncation is determined by the variable @code{truncate-lines} (see
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
188 above). If the value is an integer @var{n}, lines are truncated if
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
189 the partial-width window has fewer than @var{n} columns, regardless of
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
190 the value of @code{truncate-lines}; if the partial-width window has
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
191 @var{n} or more columns, line truncation is determined by
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
192 @code{truncate-lines}. For any other non-@code{nil} value, lines are
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
193 truncated in every partial-width window, regardless of the value of
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
194 @code{truncate-lines}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 a window, that forces truncation.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199
96470
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
200 @defvar wrap-prefix
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
201 If this buffer-local variable is non-@code{nil}, it defines a
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
202 ``prefix'' that is prepended to every continuation line at
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
203 display-time. (If lines are truncated, the wrap-prefix is never
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
204 used.) It may be a string, an image, or a stretch-glyph; the value is
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
205 interpreted in the same way as a @code{display} text property.
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
206 @xref{Display Property}.
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
207
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
208 A wrap-prefix may also be specified for regions of text, using the
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
209 @code{wrap-prefix} text or overlay property. This takes precedence
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
210 over the @code{wrap-prefix} variable. @xref{Special Properties}.
96470
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
211 @end defvar
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
212
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
213 @defvar line-prefix
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
214 If this buffer-local variable is non-@code{nil}, it defines a
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
215 ``prefix'' that is prepended to every non-continuation line at
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
216 display-time. It may be a string, an image, or a stretch-glyph; the
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
217 value is interpreted in the same way as a @code{display} text
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
218 property. @xref{Display Property}.
96470
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
219
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
220 A line-prefix may also be specified for regions of text using the
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
221 @code{line-prefix} text or overlay property. This takes precedence
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
222 over the @code{line-prefix} variable. @xref{Special Properties}.
96470
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
223 @end defvar
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 96396
diff changeset
224
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 If your buffer contains @emph{very} long lines, and you use
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
226 continuation to display them, computing the continuation lines can
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
227 make Emacs redisplay slow. The column computation and indentation
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
228 functions also become slow. Then you might find it advisable to set
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 @code{cache-long-line-scans} to @code{t}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 @defvar cache-long-line-scans
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 If this variable is non-@code{nil}, various indentation and motion
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 functions, and Emacs redisplay, cache the results of scanning the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 buffer, and consult the cache to avoid rescanning regions of the buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 unless they are modified.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 Turning on the cache slows down processing of short lines somewhat.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 This variable is automatically buffer-local in every buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 @node The Echo Area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @section The Echo Area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 @cindex error display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @cindex echo area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 The @dfn{echo area} is used for displaying error messages
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 (@pxref{Errors}), for messages made with the @code{message} primitive,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 and for echoing keystrokes. It is not the same as the minibuffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 despite the fact that the minibuffer appears (when active) in the same
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 place on the screen as the echo area. The @cite{GNU Emacs Manual}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 specifies the rules for resolving conflicts between the echo area and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 the minibuffer for use of that screen space (@pxref{Minibuffer,, The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 Minibuffer, emacs, The GNU Emacs Manual}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 You can write output in the echo area by using the Lisp printing
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 functions with @code{t} as the stream (@pxref{Output Functions}), or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 explicitly.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 * Displaying Messages:: Explicitly displaying text in the echo area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 * Progress:: Informing user about progress of a long operation.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 * Logging Messages:: Echo area messages are logged for the user.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 * Echo Area Customization:: Controlling the echo area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 @node Displaying Messages
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 @subsection Displaying Messages in the Echo Area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 @cindex display message in echo area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 This section describes the functions for explicitly producing echo
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 area messages. Many other Emacs features display messages there, too.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @defun message format-string &rest arguments
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 This function displays a message in the echo area. The argument
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 @var{format-string} is similar to a C language @code{printf} format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 string. See @code{format} in @ref{Formatting Strings}, for the details
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 on the conversion specifications. @code{message} returns the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 constructed string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 In batch mode, @code{message} prints the message text on the standard
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 error stream, followed by a newline.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 If @var{format-string}, or strings among the @var{arguments}, have
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 @code{face} text properties, these affect the way the message is displayed.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 @c Emacs 19 feature
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 If @var{format-string} is @code{nil} or the empty string,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 @code{message} clears the echo area; if the echo area has been
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 expanded automatically, this brings it back to its normal size.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 If the minibuffer is active, this brings the minibuffer contents back
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 onto the screen immediately.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 (message "Minibuffer depth is %d."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 (minibuffer-depth))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 @print{} Minibuffer depth is 0.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 @result{} "Minibuffer depth is 0."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 ---------- Echo Area ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 Minibuffer depth is 0.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 ---------- Echo Area ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 To automatically display a message in the echo area or in a pop-buffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 depending on its size, use @code{display-message-or-buffer} (see below).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 @defmac with-temp-message message &rest body
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 This construct displays a message in the echo area temporarily, during
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 the execution of @var{body}. It displays @var{message}, executes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @var{body}, then returns the value of the last body form while restoring
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 the previous echo area contents.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 @end defmac
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @defun message-or-box format-string &rest arguments
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 This function displays a message like @code{message}, but may display it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 in a dialog box instead of the echo area. If this function is called in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 a command that was invoked using the mouse---more precisely, if
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 @code{nil} or a list---then it uses a dialog box or pop-up menu to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 display the message. Otherwise, it uses the echo area. (This is the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 same criterion that @code{y-or-n-p} uses to make a similar decision; see
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @ref{Yes-or-No Queries}.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 You can force use of the mouse or of the echo area by binding
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 @code{last-nonmenu-event} to a suitable value around the call.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @defun message-box format-string &rest arguments
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 @anchor{message-box}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 This function displays a message like @code{message}, but uses a dialog
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 box (or a pop-up menu) whenever that is possible. If it is impossible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 to use a dialog box or pop-up menu, because the terminal does not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 support them, then @code{message-box} uses the echo area, like
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 @code{message}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 @defun display-message-or-buffer message &optional buffer-name not-this-window frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 This function displays the message @var{message}, which may be either a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 string or a buffer. If it is shorter than the maximum height of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 echo area, as defined by @code{max-mini-window-height}, it is displayed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 in the echo area, using @code{message}. Otherwise,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 @code{display-buffer} is used to show it in a pop-up buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 Returns either the string shown in the echo area, or when a pop-up
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 buffer is used, the window used to display it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 If @var{message} is a string, then the optional argument
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 @var{buffer-name} is the name of the buffer used to display it when a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 pop-up buffer is used, defaulting to @samp{*Message*}. In the case
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 where @var{message} is a string and displayed in the echo area, it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 not specified whether the contents are inserted into the buffer anyway.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 The optional arguments @var{not-this-window} and @var{frame} are as for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 @code{display-buffer}, and only used if a buffer is displayed.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @defun current-message
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 This function returns the message currently being displayed in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 echo area, or @code{nil} if there is none.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 @node Progress
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 @subsection Reporting Operation Progress
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 @cindex progress reporting
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 When an operation can take a while to finish, you should inform the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 user about the progress it makes. This way the user can estimate
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 remaining time and clearly see that Emacs is busy working, not hung.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 Functions listed in this section provide simple and efficient way of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 reporting operation progress. Here is a working example that does
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 nothing useful:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 (let ((progress-reporter
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 (make-progress-reporter "Collecting mana for Emacs..."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 0 500)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 (dotimes (k 500)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 (sit-for 0.01)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 (progress-reporter-update progress-reporter k))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 (progress-reporter-done progress-reporter))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 @defun make-progress-reporter message min-value max-value &optional current-value min-change min-time
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 This function creates and returns a @dfn{progress reporter}---an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 object you will use as an argument for all other functions listed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 here. The idea is to precompute as much data as possible to make
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 progress reporting very fast.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 When this progress reporter is subsequently used, it will display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @var{message} in the echo area, followed by progress percentage.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 @var{message} is treated as a simple string. If you need it to depend
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 on a filename, for instance, use @code{format} before calling this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 function.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @var{min-value} and @var{max-value} arguments stand for starting and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 final states of your operation. For instance, if you scan a buffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 they should be the results of @code{point-min} and @code{point-max}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 correspondingly. It is required that @var{max-value} is greater than
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @var{min-value}. If you create progress reporter when some part of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 the operation has already been completed, then specify
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 @var{current-value} argument. But normally you should omit it or set
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 it to @code{nil}---it will default to @var{min-value} then.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 Remaining arguments control the rate of echo area updates. Progress
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 reporter will wait for at least @var{min-change} more percents of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 operation to be completed before printing next message.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 @var{min-time} specifies the minimum time in seconds to pass between
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 successive prints. It can be fractional. Depending on Emacs and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 system capabilities, progress reporter may or may not respect this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 last argument or do it with varying precision. Default value for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 @var{min-change} is 1 (one percent), for @var{min-time}---0.2
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 (seconds.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 This function calls @code{progress-reporter-update}, so the first
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 message is printed immediately.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 @defun progress-reporter-update reporter value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 This function does the main work of reporting progress of your
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 operation. It displays the message of @var{reporter}, followed by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 progress percentage determined by @var{value}. If percentage is zero,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 or close enough according to the @var{min-change} and @var{min-time}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 arguments, then it is omitted from the output.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @var{reporter} must be the result of a call to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 @code{make-progress-reporter}. @var{value} specifies the current
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 state of your operation and must be between @var{min-value} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 @var{max-value} (inclusive) as passed to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 @code{make-progress-reporter}. For instance, if you scan a buffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 then @var{value} should be the result of a call to @code{point}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 This function respects @var{min-change} and @var{min-time} as passed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 to @code{make-progress-reporter} and so does not output new messages
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 on every invocation. It is thus very fast and normally you should not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 try to reduce the number of calls to it: resulting overhead will most
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 likely negate your effort.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 @defun progress-reporter-force-update reporter value &optional new-message
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 This function is similar to @code{progress-reporter-update} except
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 that it prints a message in the echo area unconditionally.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 The first two arguments have the same meaning as for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @code{progress-reporter-update}. Optional @var{new-message} allows
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 you to change the message of the @var{reporter}. Since this functions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 always updates the echo area, such a change will be immediately
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 presented to the user.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 @defun progress-reporter-done reporter
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 This function should be called when the operation is finished. It
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 prints the message of @var{reporter} followed by word ``done'' in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 echo area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 You should always call this function and not hope for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 @code{progress-reporter-update} to print ``100%.'' Firstly, it may
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 never print it, there are many good reasons for this not to happen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 Secondly, ``done'' is more explicit.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 @defmac dotimes-with-progress-reporter (var count [result]) message body@dots{}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 This is a convenience macro that works the same way as @code{dotimes}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 does, but also reports loop progress using the functions described
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 above. It allows you to save some typing.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 You can rewrite the example in the beginning of this node using
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 this macro this way:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 (dotimes-with-progress-reporter
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 (k 500)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 "Collecting some mana for Emacs..."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 (sit-for 0.01))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 @end defmac
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 @node Logging Messages
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 @subsection Logging Messages in @samp{*Messages*}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 @cindex logging echo-area messages
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 Almost all the messages displayed in the echo area are also recorded
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 in the @samp{*Messages*} buffer so that the user can refer back to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 them. This includes all the messages that are output with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @code{message}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 @defopt message-log-max
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 This variable specifies how many lines to keep in the @samp{*Messages*}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 buffer. The value @code{t} means there is no limit on how many lines to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 keep. The value @code{nil} disables message logging entirely. Here's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 how to display a message and prevent it from being logged:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 (let (message-log-max)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 (message @dots{}))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 To make @samp{*Messages*} more convenient for the user, the logging
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 facility combines successive identical messages. It also combines
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 successive related messages for the sake of two cases: question
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 followed by answer, and a series of progress messages.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 A ``question followed by an answer'' means two messages like the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 ones produced by @code{y-or-n-p}: the first is @samp{@var{question}},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 and the second is @samp{@var{question}...@var{answer}}. The first
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 message conveys no additional information beyond what's in the second,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 so logging the second message discards the first from the log.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 A ``series of progress messages'' means successive messages like
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 those produced by @code{make-progress-reporter}. They have the form
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @samp{@var{base}...@var{how-far}}, where @var{base} is the same each
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 time, while @var{how-far} varies. Logging each message in the series
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 discards the previous one, provided they are consecutive.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 The functions @code{make-progress-reporter} and @code{y-or-n-p}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 don't have to do anything special to activate the message log
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 combination feature. It operates whenever two consecutive messages
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 are logged that share a common prefix ending in @samp{...}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 @node Echo Area Customization
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @subsection Echo Area Customization
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 These variables control details of how the echo area works.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 @defvar cursor-in-echo-area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 This variable controls where the cursor appears when a message is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 displayed in the echo area. If it is non-@code{nil}, then the cursor
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 appears at the end of the message. Otherwise, the cursor appears at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 point---not in the echo area at all.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 The value is normally @code{nil}; Lisp programs bind it to @code{t}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 for brief periods of time.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 @defvar echo-area-clear-hook
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 This normal hook is run whenever the echo area is cleared---either by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 @code{(message nil)} or for any other reason.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
547 @defopt echo-keystrokes
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 This variable determines how much time should elapse before command
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 characters echo. Its value must be an integer or floating point number,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 which specifies the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 number of seconds to wait before echoing. If the user types a prefix
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 key (such as @kbd{C-x}) and then delays this many seconds before
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 continuing, the prefix key is echoed in the echo area. (Once echoing
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 begins in a key sequence, all subsequent characters in the same key
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 sequence are echoed immediately.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 If the value is zero, then command input is not echoed.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
558 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 @defvar message-truncate-lines
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 Normally, displaying a long message resizes the echo area to display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 the entire message. But if the variable @code{message-truncate-lines}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 is non-@code{nil}, the echo area does not resize, and the message is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 truncated to fit it, as in Emacs 20 and before.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 The variable @code{max-mini-window-height}, which specifies the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 maximum height for resizing minibuffer windows, also applies to the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 echo area (which is really a special use of the minibuffer window.
98185
c9d121831418 * display.texi (Echo Area Customization): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 97725
diff changeset
570 @xref{Minibuffer Misc}.).
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @node Warnings
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @section Reporting Warnings
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 @cindex warnings
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 @dfn{Warnings} are a facility for a program to inform the user of a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 possible problem, but continue running.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 * Warning Basics:: Warnings concepts and functions to report them.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 * Warning Variables:: Variables programs bind to customize their warnings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 * Warning Options:: Variables users set to control display of warnings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @node Warning Basics
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @subsection Warning Basics
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @cindex severity level
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 Every warning has a textual message, which explains the problem for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 the user, and a @dfn{severity level} which is a symbol. Here are the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 possible severity levels, in order of decreasing severity, and their
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 meanings:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 @item :emergency
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 A problem that will seriously impair Emacs operation soon
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 if you do not attend to it promptly.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @item :error
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 A report of data or circumstances that are inherently wrong.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @item :warning
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 A report of data or circumstances that are not inherently wrong, but
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 raise suspicion of a possible problem.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 @item :debug
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 A report of information that may be useful if you are debugging.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 When your program encounters invalid input data, it can either
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 signal a Lisp error by calling @code{error} or @code{signal} or report
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 a warning with severity @code{:error}. Signaling a Lisp error is the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 easiest thing to do, but it means the program cannot continue
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 processing. If you want to take the trouble to implement a way to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 continue processing despite the bad data, then reporting a warning of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 severity @code{:error} is the right way to inform the user of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 problem. For instance, the Emacs Lisp byte compiler can report an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 error that way and continue compiling other functions. (If the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 program signals a Lisp error and then handles it with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 @code{condition-case}, the user won't see the error message; it could
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 show the message to the user by reporting it as a warning.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 @cindex warning type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 Each warning has a @dfn{warning type} to classify it. The type is a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 list of symbols. The first symbol should be the custom group that you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 use for the program's user options. For example, byte compiler
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 warnings use the warning type @code{(bytecomp)}. You can also
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 subcategorize the warnings, if you wish, by using more symbols in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 list.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 @defun display-warning type message &optional level buffer-name
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 This function reports a warning, using @var{message} as the message
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 and @var{type} as the warning type. @var{level} should be the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 severity level, with @code{:warning} being the default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 for logging the warning. By default, it is @samp{*Warnings*}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @defun lwarn type level message &rest args
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 This function reports a warning using the value of @code{(format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @var{message} @var{args}...)} as the message. In other respects it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 equivalent to @code{display-warning}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @defun warn message &rest args
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 This function reports a warning using the value of @code{(format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 @var{message} @var{args}...)} as the message, @code{(emacs)} as the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 type, and @code{:warning} as the severity level. It exists for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 compatibility only; we recommend not using it, because you should
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 specify a specific warning type.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @node Warning Variables
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @subsection Warning Variables
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 Programs can customize how their warnings appear by binding
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 the variables described in this section.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 @defvar warning-levels
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 This list defines the meaning and severity order of the warning
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 severity levels. Each element defines one severity level,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 and they are arranged in order of decreasing severity.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 Each element has the form @code{(@var{level} @var{string}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @var{function})}, where @var{level} is the severity level it defines.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @var{string} specifies the textual description of this level.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 @var{string} should use @samp{%s} to specify where to put the warning
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 type information, or it can omit the @samp{%s} so as not to include
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 that information.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 The optional @var{function}, if non-@code{nil}, is a function to call
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 with no arguments, to get the user's attention.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 Normally you should not change the value of this variable.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 @defvar warning-prefix-function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 If non-@code{nil}, the value is a function to generate prefix text for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 warnings. Programs can bind the variable to a suitable function.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 @code{display-warning} calls this function with the warnings buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 current, and the function can insert text in it. That text becomes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 the beginning of the warning message.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 The function is called with two arguments, the severity level and its
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 entry in @code{warning-levels}. It should return a list to use as the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 entry (this value need not be an actual member of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @code{warning-levels}). By constructing this value, the function can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 change the severity of the warning, or specify different handling for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 a given severity level.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 If the variable's value is @code{nil} then there is no function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 to call.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 @defvar warning-series
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 Programs can bind this variable to @code{t} to say that the next
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 warning should begin a series. When several warnings form a series,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 that means to leave point on the first warning of the series, rather
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 than keep moving it for each warning so that it appears on the last one.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 The series ends when the local binding is unbound and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @code{warning-series} becomes @code{nil} again.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 The value can also be a symbol with a function definition. That is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 equivalent to @code{t}, except that the next warning will also call
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 the function with no arguments with the warnings buffer current. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 function can insert text which will serve as a header for the series
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 of warnings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 Once a series has begun, the value is a marker which points to the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 buffer position in the warnings buffer of the start of the series.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 The variable's normal value is @code{nil}, which means to handle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 each warning separately.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 @defvar warning-fill-prefix
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 When this variable is non-@code{nil}, it specifies a fill prefix to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 use for filling each warning's text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @defvar warning-type-format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 This variable specifies the format for displaying the warning type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 in the warning message. The result of formatting the type this way
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 gets included in the message under the control of the string in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 entry in @code{warning-levels}. The default value is @code{" (%s)"}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 If you bind it to @code{""} then the warning type won't appear at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 all.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @node Warning Options
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 @subsection Warning Options
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 These variables are used by users to control what happens
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 when a Lisp program reports a warning.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 @defopt warning-minimum-level
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 This user option specifies the minimum severity level that should be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 shown immediately to the user. The default is @code{:warning}, which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 means to immediately display all warnings except @code{:debug}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 warnings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 @defopt warning-minimum-log-level
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 This user option specifies the minimum severity level that should be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 logged in the warnings buffer. The default is @code{:warning}, which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 means to log all warnings except @code{:debug} warnings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @defopt warning-suppress-types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 This list specifies which warning types should not be displayed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 immediately for the user. Each element of the list should be a list
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 of symbols. If its elements match the first elements in a warning
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 type, then that warning is not displayed immediately.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @defopt warning-suppress-log-types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 This list specifies which warning types should not be logged in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 warnings buffer. Each element of the list should be a list of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 symbols. If it matches the first few elements in a warning type, then
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 that warning is not logged.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @node Invisible Text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 @section Invisible Text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @cindex invisible text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 You can make characters @dfn{invisible}, so that they do not appear on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 the screen, with the @code{invisible} property. This can be either a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 text property (@pxref{Text Properties}) or a property of an overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 (@pxref{Overlays}). Cursor motion also partly ignores these
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 characters; if the command loop finds point within them, it moves
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 point to the other side of them.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 In the simplest case, any non-@code{nil} @code{invisible} property makes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 a character invisible. This is the default case---if you don't alter
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 the default value of @code{buffer-invisibility-spec}, this is how the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 @code{invisible} property works. You should normally use @code{t}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 as the value of the @code{invisible} property if you don't plan
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 to set @code{buffer-invisibility-spec} yourself.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 More generally, you can use the variable @code{buffer-invisibility-spec}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 to control which values of the @code{invisible} property make text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 invisible. This permits you to classify the text into different subsets
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 in advance, by giving them different @code{invisible} values, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 subsequently make various subsets visible or invisible by changing the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 value of @code{buffer-invisibility-spec}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 Controlling visibility with @code{buffer-invisibility-spec} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 especially useful in a program to display the list of entries in a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 database. It permits the implementation of convenient filtering
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 commands to view just a part of the entries in the database. Setting
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 this variable is very fast, much faster than scanning all the text in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 the buffer looking for properties to change.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 @defvar buffer-invisibility-spec
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 This variable specifies which kinds of @code{invisible} properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 actually make a character invisible. Setting this variable makes it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 buffer-local.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @item @code{t}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 A character is invisible if its @code{invisible} property is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 non-@code{nil}. This is the default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 @item a list
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 Each element of the list specifies a criterion for invisibility; if a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 character's @code{invisible} property fits any one of these criteria,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 the character is invisible. The list can have two kinds of elements:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 @item @var{atom}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 A character is invisible if its @code{invisible} property value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 is @var{atom} or if it is a list with @var{atom} as a member.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @item (@var{atom} . t)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 A character is invisible if its @code{invisible} property value is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @var{atom} or if it is a list with @var{atom} as a member. Moreover,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 a sequence of such characters displays as an ellipsis.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 Two functions are specifically provided for adding elements to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @code{buffer-invisibility-spec} and removing elements from it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @defun add-to-invisibility-spec element
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 This function adds the element @var{element} to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @code{buffer-invisibility-spec}. If @code{buffer-invisibility-spec}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 was @code{t}, it changes to a list, @code{(t)}, so that text whose
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @code{invisible} property is @code{t} remains invisible.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @defun remove-from-invisibility-spec element
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 This removes the element @var{element} from
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 @code{buffer-invisibility-spec}. This does nothing if @var{element}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 is not in the list.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 A convention for use of @code{buffer-invisibility-spec} is that a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 major mode should use the mode's own name as an element of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @code{buffer-invisibility-spec} and as the value of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @code{invisible} property:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 ;; @r{If you want to display an ellipsis:}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 (add-to-invisibility-spec '(my-symbol . t))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 ;; @r{If you don't want ellipsis:}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 (add-to-invisibility-spec 'my-symbol)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 (overlay-put (make-overlay beginning end)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 'invisible 'my-symbol)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 ;; @r{When done with the overlays:}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 (remove-from-invisibility-spec '(my-symbol . t))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 ;; @r{Or respectively:}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 (remove-from-invisibility-spec 'my-symbol)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
857 You can check for invisibility using the following function:
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
858
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
859 @defun invisible-p pos-or-prop
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
860 If @var{pos-or-prop} is a marker or number, this function returns a
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
861 non-@code{nil} value if the text at that position is invisible.
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
862
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
863 If @var{pos-or-prop} is any other kind of Lisp object, that is taken
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
864 to mean a possible value of the @code{invisible} text or overlay
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
865 property. In that case, this function returns a non-@code{nil} value
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
866 if that value would cause text to become invisible, based on the
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
867 current value of @code{buffer-invisibility-spec}.
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
868 @end defun
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
869
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @vindex line-move-ignore-invisible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 Ordinarily, functions that operate on text or move point do not care
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 whether the text is invisible. The user-level line motion commands
102950
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
873 ignore invisible newlines if @code{line-move-ignore-invisible} is
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
874 non-@code{nil} (the default), but only because they are explicitly
6a1a6758ec3e * display.texi (Refresh Screen): Note that a passage about screen
Chong Yidong <cyd@stupidchicken.com>
parents: 102932
diff changeset
875 programmed to do so.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 However, if a command ends with point inside or immediately before
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 invisible text, the main editing loop moves point further forward or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 further backward (in the same direction that the command already moved
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 it) until that condition is no longer true. Thus, if the command
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 moved point back into an invisible range, Emacs moves point back to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 the beginning of that range, and then back one more character. If the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 command moved point forward into an invisible range, Emacs moves point
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 forward up to the first visible character that follows the invisible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 Incremental search can make invisible overlays visible temporarily
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 and/or permanently when a match includes invisible text. To enable
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 this, the overlay should have a non-@code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 @code{isearch-open-invisible} property. The property value should be a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 function to be called with the overlay as an argument. This function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 should make the overlay visible permanently; it is used when the match
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 overlaps the overlay on exit from the search.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 During the search, such overlays are made temporarily visible by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 temporarily modifying their invisible and intangible properties. If you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 want this to be done differently for a certain overlay, give it an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @code{isearch-open-invisible-temporary} property which is a function.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 The function is called with two arguments: the first is the overlay, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 the second is @code{nil} to make the overlay visible, or @code{t} to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 make it invisible again.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @node Selective Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 @section Selective Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 @c @cindex selective display Duplicates selective-display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 @dfn{Selective display} refers to a pair of related features for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 hiding certain lines on the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 The first variant, explicit selective display, is designed for use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 in a Lisp program: it controls which lines are hidden by altering the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 text. This kind of hiding in some ways resembles the effect of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 @code{invisible} property (@pxref{Invisible Text}), but the two
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 features are different and do not work the same way.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 In the second variant, the choice of lines to hide is made
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 automatically based on indentation. This variant is designed to be a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 user-level feature.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 The way you control explicit selective display is by replacing a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 newline (control-j) with a carriage return (control-m). The text that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 was formerly a line following that newline is now hidden. Strictly
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 speaking, it is temporarily no longer a line at all, since only
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 newlines can separate lines; it is now part of the previous line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 Selective display does not directly affect editing commands. For
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 into hidden text. However, the replacement of newline characters with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 carriage return characters affects some editing commands. For
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 example, @code{next-line} skips hidden lines, since it searches only
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 for newlines. Modes that use selective display can also define
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 commands that take account of the newlines, or that control which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 parts of the text are hidden.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 When you write a selectively displayed buffer into a file, all the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 control-m's are output as newlines. This means that when you next read
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 in the file, it looks OK, with nothing hidden. The selective display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 effect is seen only within Emacs.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 @defvar selective-display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 This buffer-local variable enables selective display. This means that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 lines, or portions of lines, may be made hidden.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @itemize @bullet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 If the value of @code{selective-display} is @code{t}, then the character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 control-m marks the start of hidden text; the control-m, and the rest
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 of the line following it, are not displayed. This is explicit selective
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 display.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 If the value of @code{selective-display} is a positive integer, then
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 lines that start with more than that many columns of indentation are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 displayed.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 When some portion of a buffer is hidden, the vertical movement
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 commands operate as if that portion did not exist, allowing a single
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 @code{next-line} command to skip any number of hidden lines.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 However, character movement commands (such as @code{forward-char}) do
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 not skip the hidden portion, and it is possible (if tricky) to insert
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 or delete text in an hidden portion.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 In the examples below, we show the @emph{display appearance} of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 buffer @code{foo}, which changes with the value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @code{selective-display}. The @emph{contents} of the buffer do not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 change.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 (setq selective-display nil)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 @result{} nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 1 on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 2on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 3n this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 3n this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 2on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 1 on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 (setq selective-display 2)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @result{} 2
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 1 on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 2on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 2on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 1 on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
998 @defopt selective-display-ellipses
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 If this buffer-local variable is non-@code{nil}, then Emacs displays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 @samp{@dots{}} at the end of a line that is followed by hidden text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 This example is a continuation of the previous one.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 (setq selective-display-ellipses t)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 @result{} t
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 1 on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 2on this column ...
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 2on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 1 on this column
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 You can use a display table to substitute other text for the ellipsis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 (@samp{@dots{}}). @xref{Display Tables}.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
1019 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @node Temporary Displays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 @section Temporary Displays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 Temporary displays are used by Lisp programs to put output into a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 buffer and then present it to the user for perusal rather than for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 editing. Many help commands use this feature.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 @defspec with-output-to-temp-buffer buffer-name forms@dots{}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 This function executes @var{forms} while arranging to insert any output
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 they print into the buffer named @var{buffer-name}, which is first
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 created if necessary, and put into Help mode. Finally, the buffer is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 displayed in some window, but not selected.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 If the @var{forms} do not change the major mode in the output buffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 so that it is still Help mode at the end of their execution, then
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 @code{with-output-to-temp-buffer} makes this buffer read-only at the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 end, and also scans it for function and variable names to make them
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 into clickable cross-references. @xref{Docstring hyperlinks, , Tips
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 for Documentation Strings}, in particular the item on hyperlinks in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 documentation strings, for more details.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 The string @var{buffer-name} specifies the temporary buffer, which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 need not already exist. The argument must be a string, not a buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 The buffer is erased initially (with no questions asked), and it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 marked as unmodified after @code{with-output-to-temp-buffer} exits.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @code{with-output-to-temp-buffer} binds @code{standard-output} to the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 temporary buffer, then it evaluates the forms in @var{forms}. Output
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 using the Lisp output functions within @var{forms} goes by default to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 that buffer (but screen display and messages in the echo area, although
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 they are ``output'' in the general sense of the word, are not affected).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @xref{Output Functions}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 Several hooks are available for customizing the behavior
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 of this construct; they are listed below.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 The value of the last form in @var{forms} is returned.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 This is the contents of foo.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 (with-output-to-temp-buffer "foo"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 (print 20)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 (print standard-output))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 @result{} #<buffer foo>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 20
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 #<buffer foo>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 @end defspec
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
1082 @defopt temp-buffer-show-function
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 If this variable is non-@code{nil}, @code{with-output-to-temp-buffer}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 calls it as a function to do the job of displaying a help buffer. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 function gets one argument, which is the buffer it should display.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 It is a good idea for this function to run @code{temp-buffer-show-hook}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 just as @code{with-output-to-temp-buffer} normally would, inside of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 @code{save-selected-window} and with the chosen window and buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 selected.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
1091 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 @defvar temp-buffer-setup-hook
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 This normal hook is run by @code{with-output-to-temp-buffer} before
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 evaluating @var{body}. When the hook runs, the temporary buffer is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 current. This hook is normally set up with a function to put the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 buffer in Help mode.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @defvar temp-buffer-show-hook
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 This normal hook is run by @code{with-output-to-temp-buffer} after
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 displaying the temporary buffer. When the hook runs, the temporary buffer
97627
33d44d4ba1ed (Temporary Displays): Remove unnecessary comment about usage of
Chong Yidong <cyd@stupidchicken.com>
parents: 97043
diff changeset
1103 is current, and the window it was displayed in is selected.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 @defun momentary-string-display string position &optional char message
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 This function momentarily displays @var{string} in the current buffer at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @var{position}. It has no effect on the undo list or on the buffer's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 modification status.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 The momentary display remains until the next input event. If the next
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 input event is @var{char}, @code{momentary-string-display} ignores it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 and returns. Otherwise, that event remains buffered for subsequent use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 as input. Thus, typing @var{char} will simply remove the string from
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 the display, while typing (say) @kbd{C-f} will remove the string from
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 the display and later (presumably) move point forward. The argument
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 @var{char} is a space by default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 The return value of @code{momentary-string-display} is not meaningful.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 If the string @var{string} does not contain control characters, you can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 do the same job in a more general way by creating (and then subsequently
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 deleting) an overlay with a @code{before-string} property.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @xref{Overlay Properties}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 If @var{message} is non-@code{nil}, it is displayed in the echo area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 while @var{string} is displayed in the buffer. If it is @code{nil}, a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 default message says to type @var{char} to continue.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 In this example, point is initially located at the beginning of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 second line:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 This is the contents of foo.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 @point{}Second line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 (momentary-string-display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 "**** Important Message! ****"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 (point) ?\r
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 "Type RET when done reading")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @result{} t
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 This is the contents of foo.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 **** Important Message! ****Second line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 ---------- Buffer: foo ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 ---------- Echo Area ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 Type RET when done reading
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 ---------- Echo Area ----------
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @node Overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @section Overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @cindex overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 You can use @dfn{overlays} to alter the appearance of a buffer's text on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 the screen, for the sake of presentation features. An overlay is an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 object that belongs to a particular buffer, and has a specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 beginning and end. It also has properties that you can examine and set;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 these affect the display of the text within the overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171
102932
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1172 @cindex scalability of overlays
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1173 The visual effect of an overlay is the same as of the corresponding
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1174 text property (@pxref{Text Properties}). However, due to a different
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1175 implementation, overlays generally don't scale well (many operations
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1176 take a time that is proportional to the number of overlays in the
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1177 buffer). If you need to affect the visual appearance of many portions
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1178 in the buffer, we recommend using text properties.
102932
12eccf796fc2 (Overlays): Overlays don't scale well. See
Eli Zaretskii <eliz@gnu.org>
parents: 102893
diff changeset
1179
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 An overlay uses markers to record its beginning and end; thus,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 editing the text of the buffer adjusts the beginning and end of each
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 overlay so that it stays with the text. When you create the overlay,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 you can specify whether text inserted at the beginning should be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 inside the overlay or outside, and likewise for the end of the overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 * Managing Overlays:: Creating and moving overlays.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 * Overlay Properties:: How to read and set properties.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 What properties do to the screen display.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 * Finding Overlays:: Searching for overlays.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @node Managing Overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 @subsection Managing Overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 This section describes the functions to create, delete and move
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 overlays, and to examine their contents. Overlay changes are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 recorded in the buffer's undo list, since the overlays are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 part of the buffer's contents.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 @defun overlayp object
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 This function returns @code{t} if @var{object} is an overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 @defun make-overlay start end &optional buffer front-advance rear-advance
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 This function creates and returns an overlay that belongs to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 and @var{end} must specify buffer positions; they may be integers or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 markers. If @var{buffer} is omitted, the overlay is created in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 current buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 The arguments @var{front-advance} and @var{rear-advance} specify the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 marker insertion type for the start of the overlay and for the end of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 the overlay, respectively. @xref{Marker Insertion Types}. If they
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 are both @code{nil}, the default, then the overlay extends to include
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 any text inserted at the beginning, but not text inserted at the end.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 If @var{front-advance} is non-@code{nil}, text inserted at the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 beginning of the overlay is excluded from the overlay. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 @var{rear-advance} is non-@code{nil}, text inserted at the end of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 overlay is included in the overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 @defun overlay-start overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 This function returns the position at which @var{overlay} starts,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 as an integer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 @defun overlay-end overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 This function returns the position at which @var{overlay} ends,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 as an integer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 @defun overlay-buffer overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 This function returns the buffer that @var{overlay} belongs to. It
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235 returns @code{nil} if @var{overlay} has been deleted.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 @defun delete-overlay overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 This function deletes @var{overlay}. The overlay continues to exist as
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 a Lisp object, and its property list is unchanged, but it ceases to be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 attached to the buffer it belonged to, and ceases to have any effect on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 display.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 A deleted overlay is not permanently disconnected. You can give it a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 position in a buffer again by calling @code{move-overlay}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 @defun move-overlay overlay start end &optional buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 This function moves @var{overlay} to @var{buffer}, and places its bounds
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 at @var{start} and @var{end}. Both arguments @var{start} and @var{end}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 must specify buffer positions; they may be integers or markers.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 If @var{buffer} is omitted, @var{overlay} stays in the same buffer it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 was already associated with; if @var{overlay} was deleted, it goes into
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 the current buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 The return value is @var{overlay}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 This is the only valid way to change the endpoints of an overlay. Do
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 not try modifying the markers in the overlay by hand, as that fails to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 update other vital data structures and can cause some overlays to be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 ``lost.''
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 @defun remove-overlays &optional start end name value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 This function removes all the overlays between @var{start} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 @var{end} whose property @var{name} has the value @var{value}. It can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 move the endpoints of the overlays in the region, or split them.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 If @var{name} is omitted or @code{nil}, it means to delete all overlays in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 the specified region. If @var{start} and/or @var{end} are omitted or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272 @code{nil}, that means the beginning and end of the buffer respectively.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 Therefore, @code{(remove-overlays)} removes all the overlays in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 current buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277 Here are some examples:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 ;; @r{Create an overlay.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 (setq foo (make-overlay 1 10))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 @result{} #<overlay from 1 to 10 in display.texi>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 (overlay-start foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @result{} 1
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 (overlay-end foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 @result{} 10
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 (overlay-buffer foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 @result{} #<buffer display.texi>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 ;; @r{Give it a property we can check later.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 (overlay-put foo 'happy t)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 @result{} t
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 ;; @r{Verify the property is present.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 (overlay-get foo 'happy)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 @result{} t
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 ;; @r{Move the overlay.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296 (move-overlay foo 5 20)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 @result{} #<overlay from 5 to 20 in display.texi>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 (overlay-start foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 @result{} 5
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 (overlay-end foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 @result{} 20
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 ;; @r{Delete the overlay.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 (delete-overlay foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 @result{} nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 ;; @r{Verify it is deleted.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 foo
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 @result{} #<overlay in no buffer>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308 ;; @r{A deleted overlay has no position.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 (overlay-start foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310 @result{} nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311 (overlay-end foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312 @result{} nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 (overlay-buffer foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 @result{} nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 ;; @r{Undelete the overlay.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 (move-overlay foo 1 20)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 @result{} #<overlay from 1 to 20 in display.texi>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 ;; @r{Verify the results.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 (overlay-start foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 @result{} 1
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 (overlay-end foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 @result{} 20
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 (overlay-buffer foo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 @result{} #<buffer display.texi>
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 ;; @r{Moving and deleting the overlay does not change its properties.}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 (overlay-get foo 'happy)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 @result{} t
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 Emacs stores the overlays of each buffer in two lists, divided
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 around an arbitrary ``center position.'' One list extends backwards
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 through the buffer from that center position, and the other extends
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 forwards from that center position. The center position can be anywhere
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 in the buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 @defun overlay-recenter pos
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 This function recenters the overlays of the current buffer around
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 position @var{pos}. That makes overlay lookup faster for positions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339 near @var{pos}, but slower for positions far away from @var{pos}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342 A loop that scans the buffer forwards, creating overlays, can run
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 faster if you do @code{(overlay-recenter (point-max))} first.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 @node Overlay Properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 @subsection Overlay Properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348 Overlay properties are like text properties in that the properties that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 alter how a character is displayed can come from either source. But in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 most respects they are different. @xref{Text Properties}, for comparison.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 Text properties are considered a part of the text; overlays and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 their properties are specifically considered not to be part of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 text. Thus, copying text between various buffers and strings
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 preserves text properties, but does not try to preserve overlays.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 Changing a buffer's text properties marks the buffer as modified,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 while moving an overlay or changing its properties does not. Unlike
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 text property changes, overlay property changes are not recorded in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 the buffer's undo list.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360
85004
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1361 Since more than one overlay can specify a property value for the
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1362 same character, Emacs lets you specify a priority value of each
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1363 overlay. You should not make assumptions about which overlay will
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1364 prevail when there is a conflict and they have the same priority.
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1365
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366 These functions read and set the properties of an overlay:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 @defun overlay-get overlay prop
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 This function returns the value of property @var{prop} recorded in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 @var{overlay}, if any. If @var{overlay} does not record any value for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 that property, but it does have a @code{category} property which is a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 symbol, that symbol's @var{prop} property is used. Otherwise, the value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 is @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 @defun overlay-put overlay prop value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 This function sets the value of property @var{prop} recorded in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 @var{overlay} to @var{value}. It returns @var{value}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 @defun overlay-properties overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 This returns a copy of the property list of @var{overlay}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 See also the function @code{get-char-property} which checks both
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 overlay properties and text properties for a given character.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 @xref{Examining Properties}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389 Many overlay properties have special meanings; here is a table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390 of them:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 @item priority
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 @kindex priority @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 This property's value (which should be a nonnegative integer number)
85004
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1396 determines the priority of the overlay. No priority, or @code{nil},
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1397 means zero.
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1398
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1399 The priority matters when two or more overlays cover the same
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1400 character and both specify the same property; the one whose
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1401 @code{priority} value is larger overrides the other. For the
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1402 @code{face} property, the higher priority overlay's value does not
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1403 completely override the other value; instead, its face attributes
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1404 override the face attributes of the lower priority @code{face}
b516a4e62b87 (Overlay Properties): Explain nil as priority. Explain that conflicts
Richard M. Stallman <rms@gnu.org>
parents: 84116
diff changeset
1405 property.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 Currently, all overlays take priority over text properties. Please
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408 avoid using negative priority values, as we have not yet decided just
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409 what they should mean.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 @item window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412 @kindex window @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 If the @code{window} property is non-@code{nil}, then the overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 applies only on that window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 @item category
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 @kindex category @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418 If an overlay has a @code{category} property, we call it the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 @dfn{category} of the overlay. It should be a symbol. The properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 of the symbol serve as defaults for the properties of the overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 @item face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 @kindex face @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 This property controls the way text is displayed---for example, which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 font and which colors. @xref{Faces}, for more information.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 In the simplest case, the value is a face name. It can also be a list;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 then each element can be any of these possibilities:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 @itemize @bullet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 A face name (a symbol or string).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 A property list of face attributes. This has the form (@var{keyword}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 @var{value} @dots{}), where each @var{keyword} is a face attribute
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437 name and @var{value} is a meaningful value for that attribute. With
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 this feature, you do not need to create a face each time you want to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 specify a particular attribute for certain text. @xref{Face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 Attributes}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 A cons cell, either of the form @code{(foreground-color . @var{color-name})} or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 @code{(background-color . @var{color-name})}. These elements specify
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 just the foreground color or just the background color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 @code{(foreground-color . @var{color-name})} has the same effect as
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 @code{(:foreground @var{color-name})}; likewise for the background.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 @item mouse-face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 @kindex mouse-face @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453 This property is used instead of @code{face} when the mouse is within
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 the range of the overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 @item display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457 @kindex display @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 This property activates various features that change the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459 way text is displayed. For example, it can make text appear taller
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 or shorter, higher or lower, wider or narrower, or replaced with an image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 @xref{Display Property}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 @item help-echo
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 @kindex help-echo @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 If an overlay has a @code{help-echo} property, then when you move the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 mouse onto the text in the overlay, Emacs displays a help string in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 echo area, or in the tooltip window. For details see @ref{Text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 help-echo}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 @item modification-hooks
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 @kindex modification-hooks @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 This property's value is a list of functions to be called if any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 character within the overlay is changed or if text is inserted strictly
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 within the overlay.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 The hook functions are called both before and after each change.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 If the functions save the information they receive, and compare notes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 between calls, they can determine exactly what change has been made
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 in the buffer text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481 When called before a change, each function receives four arguments: the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 overlay, @code{nil}, and the beginning and end of the text range to be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 modified.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 When called after a change, each function receives five arguments: the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 overlay, @code{t}, the beginning and end of the text range just
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 modified, and the length of the pre-change text replaced by that range.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 (For an insertion, the pre-change length is zero; for a deletion, that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 length is the number of characters deleted, and the post-change
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 beginning and end are equal.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 If these functions modify the buffer, they should bind
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 @code{inhibit-modification-hooks} to @code{t} around doing so, to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 avoid confusing the internal mechanism that calls these hooks.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 Text properties also support the @code{modification-hooks} property,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 but the details are somewhat different (@pxref{Special Properties}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 @item insert-in-front-hooks
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 @kindex insert-in-front-hooks @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501 This property's value is a list of functions to be called before and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 after inserting text right at the beginning of the overlay. The calling
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 conventions are the same as for the @code{modification-hooks} functions.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 @item insert-behind-hooks
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506 @kindex insert-behind-hooks @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 This property's value is a list of functions to be called before and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 after inserting text right at the end of the overlay. The calling
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 conventions are the same as for the @code{modification-hooks} functions.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 @item invisible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 @kindex invisible @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 The @code{invisible} property can make the text in the overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 invisible, which means that it does not appear on the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515 @xref{Invisible Text}, for details.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 @item intangible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 @kindex intangible @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 The @code{intangible} property on an overlay works just like the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 @code{intangible} text property. @xref{Special Properties}, for details.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 @item isearch-open-invisible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 This property tells incremental search how to make an invisible overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 visible, permanently, if the final match overlaps it. @xref{Invisible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 Text}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 @item isearch-open-invisible-temporary
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 This property tells incremental search how to make an invisible overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 visible, temporarily, during the search. @xref{Invisible Text}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 @item before-string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 @kindex before-string @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 This property's value is a string to add to the display at the beginning
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 of the overlay. The string does not appear in the buffer in any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 sense---only on the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 @item after-string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 @kindex after-string @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 This property's value is a string to add to the display at the end of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 the overlay. The string does not appear in the buffer in any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 sense---only on the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1543 @item line-prefix
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1544 This property specifies a display spec to prepend to each
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1545 non-continuation line at display-time. @xref{Truncation}.
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1546
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1547 @itemx wrap-prefix
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1548 This property specifies a display spec to prepend to each continuation
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1549 line at display-time. @xref{Truncation}.
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
1550
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 @item evaporate
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 @kindex evaporate @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 If this property is non-@code{nil}, the overlay is deleted automatically
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 if it becomes empty (i.e., if its length becomes zero). If you give
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 an empty overlay a non-@code{nil} @code{evaporate} property, that deletes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 it immediately.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 @item local-map
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 @cindex keymap of character (and overlays)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 @kindex local-map @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 If this property is non-@code{nil}, it specifies a keymap for a portion
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 of the text. The property's value replaces the buffer's local map, when
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 the character after point is within the overlay. @xref{Active Keymaps}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 @item keymap
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 @kindex keymap @r{(overlay property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 The @code{keymap} property is similar to @code{local-map} but overrides the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 buffer's local map (and the map specified by the @code{local-map}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 property) rather than replacing it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571
94197
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1572 The @code{local-map} and @code{keymap} properties do not affect a
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1573 string displayed by the @code{before-string}, @code{after-string}, or
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1574 @code{display} properties. This is only relevant for mouse clicks and
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1575 other mouse events that fall on the string, since point is never on
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1576 the string. To bind special mouse events for the string, assign it a
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1577 @code{local-map} or @code{keymap} text property. @xref{Special
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1578 Properties}.
3ce489895028 (Overlay Properties): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents: 92977
diff changeset
1579
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 @node Finding Overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 @subsection Searching for Overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 @defun overlays-at pos
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 This function returns a list of all the overlays that cover the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 character at position @var{pos} in the current buffer. The list is in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 no particular order. An overlay contains position @var{pos} if it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 begins at or before @var{pos}, and ends after @var{pos}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 To illustrate usage, here is a Lisp function that returns a list of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 overlays that specify property @var{prop} for the character at point:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 (defun find-overlays-specifying (prop)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 (let ((overlays (overlays-at (point)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 found)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 (while overlays
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597 (let ((overlay (car overlays)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598 (if (overlay-get overlay prop)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 (setq found (cons overlay found))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 (setq overlays (cdr overlays)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 found))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 @defun overlays-in beg end
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 This function returns a list of the overlays that overlap the region
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 @var{beg} through @var{end}. ``Overlap'' means that at least one
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 character is contained within the overlay and also contained within the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 specified region; however, empty overlays are included in the result if
92977
8a79cbd87921 (Finding Overlays): Say that empty overlays at
Martin Rudalics <rudalics@gmx.at>
parents: 92150
diff changeset
1610 they are located at @var{beg}, strictly between @var{beg} and @var{end},
8a79cbd87921 (Finding Overlays): Say that empty overlays at
Martin Rudalics <rudalics@gmx.at>
parents: 92150
diff changeset
1611 or at @var{end} when @var{end} denotes the position at the end of the
8a79cbd87921 (Finding Overlays): Say that empty overlays at
Martin Rudalics <rudalics@gmx.at>
parents: 92150
diff changeset
1612 buffer.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 @defun next-overlay-change pos
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 This function returns the buffer position of the next beginning or end
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 of an overlay, after @var{pos}. If there is none, it returns
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 @code{(point-max)}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621 @defun previous-overlay-change pos
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622 This function returns the buffer position of the previous beginning or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 end of an overlay, before @var{pos}. If there is none, it returns
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 @code{(point-min)}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 As an example, here's a simplified (and inefficient) version of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 primitive function @code{next-single-char-property-change}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 (@pxref{Property Search}). It searches forward from position
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 @var{pos} for the next position where the value of a given property
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 @code{prop}, as obtained from either overlays or text properties,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 changes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 (defun next-single-char-property-change (position prop)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 (save-excursion
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 (goto-char position)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638 (let ((propval (get-char-property (point) prop)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 (while (and (not (eobp))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 (eq (get-char-property (point) prop) propval))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 (goto-char (min (next-overlay-change (point))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642 (next-single-property-change (point) prop)))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 (point)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 @node Width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 @section Width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649 Since not all characters have the same width, these functions let you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 check the width of a character. @xref{Primitive Indent}, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 @ref{Screen Lines}, for related functions.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 @defun char-width char
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 This function returns the width in columns of the character @var{char},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 if it were displayed in the current buffer and the selected window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 @defun string-width string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 This function returns the width in columns of the string @var{string},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 if it were displayed in the current buffer and the selected window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 @defun truncate-string-to-width string width &optional start-column padding ellipsis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664 This function returns the part of @var{string} that fits within
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 @var{width} columns, as a new string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 If @var{string} does not reach @var{width}, then the result ends where
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @var{string} ends. If one multi-column character in @var{string}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669 extends across the column @var{width}, that character is not included in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 the result. Thus, the result can fall short of @var{width} but cannot
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 go beyond it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 The optional argument @var{start-column} specifies the starting column.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 If this is non-@code{nil}, then the first @var{start-column} columns of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 the string are omitted from the value. If one multi-column character in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 @var{string} extends across the column @var{start-column}, that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677 character is not included.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679 The optional argument @var{padding}, if non-@code{nil}, is a padding
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680 character added at the beginning and end of the result string, to extend
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 it to exactly @var{width} columns. The padding character is used at the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 end of the result if it falls short of @var{width}. It is also used at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 the beginning of the result if one multi-column character in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 @var{string} extends across the column @var{start-column}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 If @var{ellipsis} is non-@code{nil}, it should be a string which will
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 replace the end of @var{str} (including any padding) if it extends
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 beyond @var{end-column}, unless the display width of @var{str} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 equal to or less than the display width of @var{ellipsis}. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 @var{ellipsis} is non-@code{nil} and not a string, it stands for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 @code{"..."}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 (truncate-string-to-width "\tab\t" 12 4)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 @result{} "ab"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 (truncate-string-to-width "\tab\t" 12 4 ?\s)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697 @result{} " ab "
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1699 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701 @node Line Height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702 @section Line Height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 @cindex line height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 The total height of each display line consists of the height of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706 contents of the line, plus optional additional vertical line spacing
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707 above or below the display line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 The height of the line contents is the maximum height of any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710 character or image on that display line, including the final newline
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711 if there is one. (A display line that is continued doesn't include a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712 final newline.) That is the default line height, if you do nothing to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 specify a greater height. (In the most common case, this equals the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714 height of the default frame font.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716 There are several ways to explicitly specify a larger line height,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 either by specifying an absolute height for the display line, or by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 specifying vertical space. However, no matter what you specify, the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1719 actual line height can never be less than the default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 @kindex line-height @r{(text property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 A newline can have a @code{line-height} text or overlay property
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 that controls the total height of the display line ending in that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724 newline.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726 If the property value is @code{t}, the newline character has no
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 effect on the displayed height of the line---the visible contents
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 alone determine the height. This is useful for tiling small images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 (or image slices) without adding blank areas between the images.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 If the property value is a list of the form @code{(@var{height}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 @var{total})}, that adds extra space @emph{below} the display line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733 First Emacs uses @var{height} as a height spec to control extra space
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734 @emph{above} the line; then it adds enough space @emph{below} the line
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 to bring the total line height up to @var{total}. In this case, the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736 other ways to specify the line spacing are ignored.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 Any other kind of property value is a height spec, which translates
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 into a number---the specified line height. There are several ways to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 write a height spec; here's how each of them translates into a number:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 @item @var{integer}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744 If the height spec is a positive integer, the height value is that integer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745 @item @var{float}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 If the height spec is a float, @var{float}, the numeric height value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 is @var{float} times the frame's default line height.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 @item (@var{face} . @var{ratio})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749 If the height spec is a cons of the format shown, the numeric height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 is @var{ratio} times the height of face @var{face}. @var{ratio} can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 be any type of number, or @code{nil} which means a ratio of 1.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 If @var{face} is @code{t}, it refers to the current face.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 @item (nil . @var{ratio})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 If the height spec is a cons of the format shown, the numeric height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 is @var{ratio} times the height of the contents of the line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758 Thus, any valid height spec determines the height in pixels, one way
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 or another. If the line contents' height is less than that, Emacs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 adds extra vertical space above the line to achieve the specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 total height.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 If you don't specify the @code{line-height} property, the line's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 height consists of the contents' height plus the line spacing.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 There are several ways to specify the line spacing for different
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 parts of Emacs text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 @vindex default-line-spacing
102981
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1769 On graphical terminals, you can specify the line spacing for all
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1770 lines in a frame, using the @code{line-spacing} frame parameter
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1771 (@pxref{Layout Parameters}). However, if the variable
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1772 @code{default-line-spacing} is non-@code{nil}, it overrides the
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1773 frame's @code{line-spacing} parameter. An integer value specifies the
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1774 number of pixels put below lines. A floating point number specifies
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1775 the spacing relative to the frame's default line height.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 @vindex line-spacing
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 You can specify the line spacing for all lines in a buffer via the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779 buffer-local @code{line-spacing} variable. An integer value specifies
102981
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1780 the number of pixels put below lines. A floating point number
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1781 specifies the spacing relative to the default frame line height. This
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1782 overrides line spacings specified for the frame.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 @kindex line-spacing @r{(text property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 Finally, a newline can have a @code{line-spacing} text or overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 property that overrides the default frame line spacing and the buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787 local @code{line-spacing} variable, for the display line ending in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 that newline.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 One way or another, these mechanisms specify a Lisp value for the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 spacing of each line. The value is a height spec, and it translates
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 into a Lisp value as described above. However, in this case the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 numeric height value specifies the line spacing, rather than the line
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 height.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795
102981
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1796 On text-only terminals, the line spacing cannot be altered.
789bf99f58e7 * display.texi (Line Height): Emphasize that line-spacing only takes
Chong Yidong <cyd@stupidchicken.com>
parents: 102975
diff changeset
1797
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 @node Faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 @section Faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800 @cindex faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1802 A @dfn{face} is a collection of graphical attributes for displaying
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1803 text: font family, foreground color, background color, optional
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1804 underlining, and so on. Faces control how buffer text is displayed,
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1805 and how some parts of the frame, such as the mode-line, are displayed.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1806 @xref{Standard Faces,,, emacs, The GNU Emacs Manual}, for the list of
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1807 faces Emacs normally comes with.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 @cindex face id
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1810 For most purposes, you refer to a face in Lisp programs using its
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1811 @dfn{face name}. This is either a string or (equivalently) a Lisp
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1812 symbol whose name is equal to that string.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 @defun facep object
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1815 This function returns a non-@code{nil} value if @var{object} is a Lisp
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1816 symbol or string that names a face. Otherwise, it returns @code{nil}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1819 Each face name is meaningful for all frames, and by default it has
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1820 the same meaning in all frames. But you can arrange to give a
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1821 particular face name a special meaning in one frame if you wish.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 * Defining Faces:: How to define a face with @code{defface}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 * Face Attributes:: What is in a face?
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 * Attribute Functions:: Functions to examine and set face attributes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 * Displaying Faces:: How Emacs combines the faces specified for a character.
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1828 * Face Remapping:: Remapping faces to alternative definitions.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 * Face Functions:: How to define and examine faces.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 * Auto Faces:: Hook for automatic face assignment.
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
1831 * Font Selection:: Finding the best available font for a face.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 * Font Lookup:: Looking up the names of available fonts
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 and information about them.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 * Fontsets:: A fontset is a collection of fonts
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 that handle a range of character sets.
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
1836 * Low-Level Font:: Lisp representation for character display fonts.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 @node Defining Faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 @subsection Defining Faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 The way to define a new face is with @code{defface}. This creates a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 kind of customization item (@pxref{Customization}) which the user can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 customize using the Customization buffer (@pxref{Easy Customization,,,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 emacs, The GNU Emacs Manual}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846
98267
559b4f23d84b (Defining Faces): Recommend against face variables.
Glenn Morris <rgm@gnu.org>
parents: 98185
diff changeset
1847 People are sometimes tempted to create variables whose values specify
559b4f23d84b (Defining Faces): Recommend against face variables.
Glenn Morris <rgm@gnu.org>
parents: 98185
diff changeset
1848 which faces to use (for example, Font-Lock does this). In the vast
559b4f23d84b (Defining Faces): Recommend against face variables.
Glenn Morris <rgm@gnu.org>
parents: 98185
diff changeset
1849 majority of cases, this is not necessary, and simply using faces
559b4f23d84b (Defining Faces): Recommend against face variables.
Glenn Morris <rgm@gnu.org>
parents: 98185
diff changeset
1850 directly is preferable.
559b4f23d84b (Defining Faces): Recommend against face variables.
Glenn Morris <rgm@gnu.org>
parents: 98185
diff changeset
1851
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852 @defmac defface face spec doc [keyword value]@dots{}
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1853 This declares @var{face} as a customizable face whose default
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1854 attributes are given by @var{spec}. You should not quote the symbol
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1855 @var{face}, and it should not end in @samp{-face} (that would be
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1856 redundant). The argument @var{doc} specifies the face documentation.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1857 The keywords you can use in @code{defface} are the same as in
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1858 @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}).
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 When @code{defface} executes, it defines the face according to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 @var{spec}, then uses any customizations that were read from the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 init file (@pxref{Init File}) to override that specification.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 When you evaluate a @code{defface} form with @kbd{C-M-x} in Emacs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 Lisp mode (@code{eval-defun}), a special feature of @code{eval-defun}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 overrides any customizations of the face. This way, the face reflects
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 exactly what the @code{defface} says.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 The purpose of @var{spec} is to specify how the face should appear on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 different kinds of terminals. It should be an alist whose elements
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 have the form @code{(@var{display} @var{atts})}. Each element's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 @sc{car}, @var{display}, specifies a class of terminals. (The first
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 element, if its @sc{car} is @code{default}, is special---it specifies
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 defaults for the remaining elements). The element's @sc{cadr},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 @var{atts}, is a list of face attributes and their values; it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 specifies what the face should look like on that kind of terminal.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 The possible attributes are defined in the value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 @code{custom-face-attributes}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 The @var{display} part of an element of @var{spec} determines which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 frames the element matches. If more than one element of @var{spec}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882 matches a given frame, the first element that matches is the one used
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 for that frame. There are three possibilities for @var{display}:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 @item @code{default}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 This element of @var{spec} doesn't match any frames; instead, it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 specifies defaults that apply to all frames. This kind of element, if
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 used, must be the first element of @var{spec}. Each of the following
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 elements can override any or all of these defaults.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 @item @code{t}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 This element of @var{spec} matches all frames. Therefore, any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 subsequent elements of @var{spec} are never used. Normally
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 @code{t} is used in the last (or only) element of @var{spec}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 @item a list
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 If @var{display} is a list, each element should have the form
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 @code{(@var{characteristic} @var{value}@dots{})}. Here
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 @var{characteristic} specifies a way of classifying frames, and the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 @var{value}s are possible classifications which @var{display} should
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 apply to. Here are the possible values of @var{characteristic}:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 @item type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 The kind of window system the frame uses---either @code{graphic} (any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console),
97043
9592c50233ab Remove support for Mac Carbon.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96470
diff changeset
1908 @code{w32} (for MS Windows 9X/NT/2K/XP), or @code{tty}
9592c50233ab Remove support for Mac Carbon.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96470
diff changeset
1909 (a non-graphics-capable display).
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 @xref{Window Systems, window-system}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 @item class
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 What kinds of colors the frame supports---either @code{color},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 @code{grayscale}, or @code{mono}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 @item background
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 The kind of background---either @code{light} or @code{dark}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 @item min-colors
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 An integer that represents the minimum number of colors the frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 should support. This matches a frame if its
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 @code{display-color-cells} value is at least the specified integer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 @item supports
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 Whether or not the frame can display the face attributes given in
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1926 @var{value}@dots{} (@pxref{Face Attributes}). @xref{Display Face
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1927 Attribute Testing}, for more information on exactly how this testing
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1928 is done.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 If an element of @var{display} specifies more than one @var{value} for a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 given @var{characteristic}, any of those values is acceptable. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 @var{display} has more than one element, each element should specify a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 different @var{characteristic}; then @emph{each} characteristic of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 frame must match one of the @var{value}s specified for it in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 @var{display}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 @end defmac
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 Here's how the standard face @code{region} is defined:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 (defface region
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 '((((class color) (min-colors 88) (background dark))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 :background "blue3")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 (((class color) (min-colors 88) (background light))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 :background "lightgoldenrod2")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 (((class color) (min-colors 16) (background dark))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 :background "blue3")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 (((class color) (min-colors 16) (background light))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 :background "lightgoldenrod2")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 (((class color) (min-colors 8))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 :background "blue" :foreground "white")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 (((type tty) (class mono))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 :inverse-video t)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 (t :background "gray"))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 "Basic face for highlighting the region."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 :group 'basic-faces)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 Internally, @code{defface} uses the symbol property
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1966 @code{face-defface-spec} to record the specified face attributes. The
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1967 attributes saved by the user with the customization buffer are
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1968 recorded in the symbol property @code{saved-face}; the attributes
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1969 customized by the user for the current session, but not saved, are
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1970 recorded in the symbol property @code{customized-face}. The
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1971 documentation string is recorded in the symbol property
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1972 @code{face-documentation}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 @defopt frame-background-mode
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 This option, if non-@code{nil}, specifies the background type to use for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 interpreting face definitions. If it is @code{dark}, then Emacs treats
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 all frames as if they had a dark background, regardless of their actual
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 background colors. If it is @code{light}, then Emacs treats all frames
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 as if they had a light background.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 @node Face Attributes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 @subsection Face Attributes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 @cindex face attributes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 The effect of using a face is determined by a fixed set of @dfn{face
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1987 attributes}. This table lists all the face attributes, their possible
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1988 values, and their effects. You can specify more than one face for a
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1989 given piece of text; Emacs merges the attributes of all the faces to
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1990 determine how to display the text. @xref{Displaying Faces}.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1991
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1992 In addition to the values given below, each face attribute can also
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1993 have the value @code{unspecified}. This special value means the face
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1994 doesn't specify that attribute. In face merging, when the first face
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1995 fails to specify a particular attribute, the next face gets a chance.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1996 However, the @code{default} face must specify all attributes.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1997
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1998 Some of these font attributes are meaningful only on certain kinds
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
1999 of displays. If your display cannot handle a certain attribute, the
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2000 attribute is ignored.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 @item :family
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2004 Font family name or fontset name (a string). If you specify a font
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2005 family name, the wild-card characters @samp{*} and @samp{?} are
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2006 allowed. The function @code{font-family-list}, described below,
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2007 returns a list of available family names. @xref{Fontsets}, for
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2008 information about fontsets.
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2009
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2010 @item :foundry
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2011 The name of the @dfn{font foundry} in which the font family specified
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2012 by the @code{:family} attribute is located (a string). The wild-card
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2013 characters @samp{*} and @samp{?} are allowed.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 @item :width
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2016 Relative proportionate character width, also known as the character
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 set width. This should be one of the symbols @code{ultra-condensed},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 @code{extra-condensed}, @code{condensed}, @code{semi-condensed},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 @code{normal}, @code{semi-expanded}, @code{expanded},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 @code{extra-expanded}, or @code{ultra-expanded}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 @item :height
104288
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2023 The height of the font. In the simplest case, this is an integer in
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2024 units of 1/10 point.
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2025
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2026 The value can also be a floating point number or a function, which
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2027 specifies the height relative to an @dfn{underlying face} (i.e., a
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2028 face that has a lower priority in the list described in
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2029 @ref{Displaying Faces}). If the value is a floating point number,
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2030 that specifies the amount by which to scale the height of the
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2031 underlying face. If the value is a function, that function is called
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2032 with one argument, the height of the underlying face, and returns the
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2033 height of the new face. If the function is passed an integer
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2034 argument, it must return an integer.
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2035
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2036 The height of the default face must be specified using an integer;
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2037 floating point and function values are not allowed.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 @item :weight
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2040 Font weight---one of the symbols (from densest to faintest)
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 @code{ultra-bold}, @code{extra-bold}, @code{bold}, @code{semi-bold},
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2042 @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, or
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2043 @code{ultra-light}. On text-only terminals that support
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2044 variable-brightness text, any weight greater than normal is displayed
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2045 as extra bright, and any weight less than normal is displayed as
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2046 half-bright.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 @item :slant
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2049 Font slant---one of the symbols @code{italic}, @code{oblique},
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2050 @code{normal}, @code{reverse-italic}, or @code{reverse-oblique}. On
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2051 text-only terminals that support variable-brightness text, slanted
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2052 text is displayed as half-bright.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 @item :foreground
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 Foreground color, a string. The value can be a system-defined color
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2056 name, or a hexadecimal color specification. @xref{Color Names}. On
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2057 black-and-white displays, certain shades of gray are implemented by
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2058 stipple patterns.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 @item :background
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2061 Background color, a string. The value can be a system-defined color
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2062 name, or a hexadecimal color specification. @xref{Color Names}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 @item :underline
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 Whether or not characters should be underlined, and in what color. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 the value is @code{t}, underlining uses the foreground color of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 face. If the value is a string, underlining uses that color. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 value @code{nil} means do not underline.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 @item :overline
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071 Whether or not characters should be overlined, and in what color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 The value is used like that of @code{:underline}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 @item :strike-through
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 Whether or not characters should be strike-through, and in what
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 color. The value is used like that of @code{:underline}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078 @item :box
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 Whether or not a box should be drawn around characters, its color, the
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2080 width of the box lines, and 3D appearance. Here are the possible
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2081 values of the @code{:box} attribute, and what they mean:
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084 @item @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 Don't draw a box.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 @item @code{t}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 Draw a box with lines of width 1, in the foreground color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 @item @var{color}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 Draw a box with lines of width 1, in color @var{color}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 @item @code{(:line-width @var{width} :color @var{color} :style @var{style})}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 This way you can explicitly specify all aspects of the box. The value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 @var{width} specifies the width of the lines to draw; it defaults to 1.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 The value @var{color} specifies the color to draw with. The default is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 the foreground color of the face for simple boxes, and the background
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 color of the face for 3D boxes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 The value @var{style} specifies whether to draw a 3D box. If it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 @code{released-button}, the box looks like a 3D button that is not being
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 pressed. If it is @code{pressed-button}, the box looks like a 3D button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 that is being pressed. If it is @code{nil} or omitted, a plain 2D box
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2108 @item :inverse-video
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2109 Whether or not characters should be displayed in inverse video. The
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2110 value should be @code{t} (yes) or @code{nil} (no).
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2111
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2112 @item :stipple
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2113 The background stipple, a bitmap.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2114
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2115 The value can be a string; that should be the name of a file containing
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2116 external-format X bitmap data. The file is found in the directories
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2117 listed in the variable @code{x-bitmap-file-path}.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2118
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2119 Alternatively, the value can specify the bitmap directly, with a list
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2120 of the form @code{(@var{width} @var{height} @var{data})}. Here,
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2121 @var{width} and @var{height} specify the size in pixels, and
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2122 @var{data} is a string containing the raw bits of the bitmap, row by
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2123 row. Each row occupies @math{(@var{width} + 7) / 8} consecutive bytes
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2124 in the string (which should be a unibyte string for best results).
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2125 This means that each row always occupies at least one whole byte.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2126
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2127 If the value is @code{nil}, that means use no stipple pattern.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2128
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2129 Normally you do not need to set the stipple attribute, because it is
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2130 used automatically to handle certain shades of gray.
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2131
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 @item :font
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2133 The font used to display the face. Its value should be a font object.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2134 @xref{Font Selection}, for information about font objects.
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2135
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2136 When specifying this attribute using @code{set-face-attribute}
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2137 (@pxref{Attribute Functions}), you may also supply a font spec, a font
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2138 entity, or a string. Emacs converts such values to an appropriate
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2139 font object, and stores that font object as the actual attribute
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2140 value. If you specify a string, the contents of the string should be
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2141 a font name (@pxref{Font X,, Font Specification Options, emacs, The
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2142 GNU Emacs Manual}); if the font name is an XLFD containing wildcards,
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2143 Emacs chooses the first font matching those wildcards. Specifying
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2144 this attribute also changes the values of the @code{:family},
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2145 @code{:foundry}, @code{:width}, @code{:height}, @code{:weight}, and
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2146 @code{:slant} attributes.
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2147
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2148 @item :inherit
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2149 The name of a face from which to inherit attributes, or a list of face
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2150 names. Attributes from inherited faces are merged into the face like
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2151 an underlying face would be, with higher priority than underlying
104288
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2152 faces (@pxref{Displaying Faces}). If a list of faces is used,
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2153 attributes from faces earlier in the list override those from later
a21bb1c0cb0e * display.texi (Face Attributes): Add xref to Displaying Faces for
Chong Yidong <cyd@stupidchicken.com>
parents: 103820
diff changeset
2154 faces.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2157 For compatibility with Emacs 20, you can also specify values for two
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2158 ``fake'' face attributes: @code{:bold} and @code{:italic}. Their
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2159 values must be either @code{t} or @code{nil}; a value of
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2160 @code{unspecified} is not allowed. Setting @code{:bold} to @code{t}
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2161 is equivalent to setting the @code{:weight} attribute to @code{bold},
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2162 and setting it to @code{nil} is equivalent to setting @code{:weight}
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2163 to @code{normal}. Setting @code{:italic} to @code{t} is equivalent to
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2164 setting the @code{:slant} attribute to @code{italic}, and setting it
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2165 to @code{nil} is equivalent to setting @code{:slant} to @code{normal}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2167 @defun font-family-list &optional frame
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2168 This function returns a list of available font family names. The
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2169 optional argument @var{frame} specifies the frame on which the text is
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2170 to be displayed; if it is @code{nil}, the selected frame is used.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2171 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2172
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2173 @defopt underline-minimum-offset
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2174 This variable specifies the minimum distance between the baseline and
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2175 the underline, in pixels, when displaying underlined text.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2176 @end defopt
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2177
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2178 @defopt x-bitmap-file-path
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 This variable specifies a list of directories for searching
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 for bitmap files, for the @code{:stipple} attribute.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2181 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 @defun bitmap-spec-p object
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 This returns @code{t} if @var{object} is a valid bitmap specification,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 suitable for use with @code{:stipple} (see above). It returns
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 @code{nil} otherwise.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189 @node Attribute Functions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 @subsection Face Attribute Functions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 This section describes the functions for accessing and modifying the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193 attributes of an existing face.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 @defun set-face-attribute face frame &rest arguments
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2196 This function sets one or more attributes of @var{face} for
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 @var{frame}. The attributes you specify this way override whatever
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 the @code{defface} says.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 The extra arguments @var{arguments} specify the attributes to set, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 the values for them. They should consist of alternating attribute names
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 (such as @code{:family} or @code{:underline}) and corresponding values.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203 Thus,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 (set-face-attribute 'foo nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 :width 'extended
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208 :weight 'bold
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 :underline "red")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 sets the attributes @code{:width}, @code{:weight} and @code{:underline}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 to the corresponding values.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 If @var{frame} is @code{t}, this function sets the default attributes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 for new frames. Default attribute values specified this way override
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 the @code{defface} for newly created frames.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 If @var{frame} is @code{nil}, this function sets the attributes for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 all existing frames, and the default for new frames.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 @defun face-attribute face attribute &optional frame inherit
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2225 This returns the value of the @var{attribute} attribute of @var{face}
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2226 on @var{frame}. If @var{frame} is @code{nil}, that means the selected
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2227 frame (@pxref{Input Focus}).
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 If @var{frame} is @code{t}, this returns whatever new-frames default
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 value you previously specified with @code{set-face-attribute} for the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 @var{attribute} attribute of @var{face}. If you have not specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 one, it returns @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 If @var{inherit} is @code{nil}, only attributes directly defined by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 @var{face} are considered, so the return value may be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 @code{unspecified}, or a relative value. If @var{inherit} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 non-@code{nil}, @var{face}'s definition of @var{attribute} is merged
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238 with the faces specified by its @code{:inherit} attribute; however the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 return value may still be @code{unspecified} or relative. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 @var{inherit} is a face or a list of faces, then the result is further
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 merged with that face (or faces), until it becomes specified and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242 absolute.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 To ensure that the return value is always specified and absolute, use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245 a value of @code{default} for @var{inherit}; this will resolve any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 unspecified or relative values by merging with the @code{default} face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 (which is always completely specified).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 For example,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 (face-attribute 'bold :weight)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253 @result{} bold
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 @defun face-attribute-relative-p attribute value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 This function returns non-@code{nil} if @var{value}, when used as the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259 value of the face attribute @var{attribute}, is relative. This means
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 it would modify, rather than completely override, any value that comes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 from a subsequent face in the face list or that is inherited from
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 another face.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2264 @code{unspecified} is a relative value for all attributes. For
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2265 @code{:height}, floating point and function values are also relative.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 For example:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 (face-attribute-relative-p :height 2.0)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 @result{} t
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274
98972
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2275 @defun face-all-attributes face &optional frame
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2276 This function returns an alist of attributes of @var{face}. The
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2277 elements of the result are name-value pairs of the form
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2278 @w{@code{(@var{attr-name} . @var{attr-value})}}. Optional argument
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2279 @var{frame} specifies the frame whose definition of @var{face} to
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2280 return; if omitted or @code{nil}, the returned value describes the
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2281 default attributes of @var{face} for newly created frames.
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2282 @end defun
8860f1bf41c3 (Attribute Functions): Document `face-all-attributes'.
Eli Zaretskii <eliz@gnu.org>
parents: 98709
diff changeset
2283
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 @defun merge-face-attribute attribute value1 value2
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 If @var{value1} is a relative value for the face attribute
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 @var{attribute}, returns it merged with the underlying value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 @var{value2}; otherwise, if @var{value1} is an absolute value for the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 face attribute @var{attribute}, returns @var{value1} unchanged.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290
100949
91ffb924a3e5 (Faces): Don't discuss face id here. facep does
Chong Yidong <cyd@stupidchicken.com>
parents: 100599
diff changeset
2291 The following functions provide compatibility with Emacs 20 and
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2292 below. They work by calling @code{set-face-attribute}. Values of
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2293 @code{t} and @code{nil} for their @var{frame} argument are handled
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 just like @code{set-face-attribute} and @code{face-attribute}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296 @defun set-face-foreground face color &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @defunx set-face-background face color &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2298 These functions set the @code{:foreground} attribute (or
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2299 @code{:background} attribute, respectively) of @var{face} to
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2300 @var{color}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303 @defun set-face-stipple face pattern &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2304 This function sets the @code{:stipple} attribute of @var{face} to
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2305 @var{pattern}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 @defun set-face-font face font &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2309 This function sets the @code{:font} attribute of @var{face} to
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 @var{font}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 @defun set-face-bold-p face bold-p &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2314 This function sets the @code{:weight} attribute of @var{face} to
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2315 @var{normal} if @var{bold-p} is @code{nil}, and to @var{bold}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2316 otherwise.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 @defun set-face-italic-p face italic-p &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2320 This function sets the @code{:slant} attribute of @var{face} to
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2321 @var{normal} if @var{italic-p} is @code{nil}, and to @var{italic}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2322 otherwise.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 @defun set-face-underline-p face underline &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2326 This function sets the @code{:underline} attribute of @var{face} to
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2327 @var{underline}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 @defun set-face-inverse-video-p face inverse-video-p &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2331 This function sets the @code{:inverse-video} attribute of @var{face}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2332 to @var{inverse-video-p}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 @defun invert-face face &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 This function swaps the foreground and background colors of face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 @var{face}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2340 The following functions examine the attributes of a face. If you
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2341 don't specify @var{frame}, they refer to the selected frame; @code{t}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2342 refers to the default data for new frames. They return the symbol
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 @code{unspecified} if the face doesn't define any value for that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 attribute.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 @defun face-foreground face &optional frame inherit
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 @defunx face-background face &optional frame inherit
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 These functions return the foreground color (or background color,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 respectively) of face @var{face}, as a string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 If @var{inherit} is @code{nil}, only a color directly defined by the face is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 returned. If @var{inherit} is non-@code{nil}, any faces specified by its
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 @code{:inherit} attribute are considered as well, and if @var{inherit}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 is a face or a list of faces, then they are also considered, until a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355 specified color is found. To ensure that the return value is always
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 specified, use a value of @code{default} for @var{inherit}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 @defun face-stipple face &optional frame inherit
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 This function returns the name of the background stipple pattern of face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 @var{face}, or @code{nil} if it doesn't have one.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 If @var{inherit} is @code{nil}, only a stipple directly defined by the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 face is returned. If @var{inherit} is non-@code{nil}, any faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365 specified by its @code{:inherit} attribute are considered as well, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 if @var{inherit} is a face or a list of faces, then they are also
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 considered, until a specified stipple is found. To ensure that the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368 return value is always specified, use a value of @code{default} for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @var{inherit}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 @defun face-font face &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373 This function returns the name of the font of face @var{face}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 @defun face-bold-p face &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2377 This function returns a non-@code{nil} value if the @code{:weight}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2378 attribute of @var{face} is bolder than normal (i.e., one of
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2379 @code{semi-bold}, @code{bold}, @code{extra-bold}, or
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2380 @code{ultra-bold}). Otherwise, it returns @code{nil}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 @defun face-italic-p face &optional frame
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2384 This function returns a non-@code{nil} value if the @code{:slant}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2385 attribute of @var{face} is @code{italic} or @code{oblique}, and
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 @code{nil} otherwise.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 @defun face-underline-p face &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 This function returns the @code{:underline} attribute of face @var{face}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 @defun face-inverse-video-p face &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 This function returns the @code{:inverse-video} attribute of face @var{face}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 @node Displaying Faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 @subsection Displaying Faces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2400 Here is how Emacs determines the face to use for displaying any
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2401 given piece of text:
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 @itemize @bullet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404 @item
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2405 If the text consists of a special glyph, the glyph can specify a
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2406 particular face. @xref{Glyphs}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408 @item
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2409 If the text lies within an active region, Emacs highlights it using
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2410 the @code{region} face. @xref{Standard Faces,,, emacs, The GNU Emacs
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2411 Manual}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 @item
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2414 If the text lies within an overlay with a non-@code{nil} @code{face}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2415 property, Emacs applies the face or face attributes specified by that
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2416 property. If the overlay has a @code{mouse-face} property and the
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2417 mouse is ``near enough'' to the overlay, Emacs applies the face or
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2418 face attributes specified by the @code{mouse-face} property instead.
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2419 @xref{Overlay Properties}.
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2420
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2421 When multiple overlays cover one character, an overlay with higher
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2422 priority overrides those with lower priority. @xref{Overlays}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424 @item
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2425 If the text contains a @code{face} or @code{mouse-face} property,
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2426 Emacs applies the specified faces and face attributes. @xref{Special
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2427 Properties}. (This is how Font Lock mode faces are applied.
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2428 @xref{Font Lock Mode}.)
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 @item
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2431 If the text lies within the mode line of the selected window, Emacs
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2432 applies the @code{mode-line} face. For the mode line of a
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2433 non-selected window, Emacs applies the @code{mode-line-inactive} face.
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2434 For a header line, Emacs applies the @code{header-line} face.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 @item
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2437 If any given attribute has not been specified during the preceding
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2438 steps, Emacs applies the attribute of the @code{default} face.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 If these various sources together specify more than one face for a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442 particular character, Emacs merges the attributes of the various faces
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2443 specified. For each attribute, Emacs tries using the above order
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2444 (i.e., first the face of any special glyph; then the face for region
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2445 highlighting, if appropriate; then faces specified by overlays, then
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2446 faces specified by text properties, then the @code{mode-line} or
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2447 @code{mode-line-inactive} or @code{header-line} face, if appropriate,
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2448 and finally the @code{default} face).
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2449
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2450 @node Face Remapping
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2451 @subsection Face Remapping
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2452
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2453 The variable @code{face-remapping-alist} is used for buffer-local or
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2454 global changes in the appearance of a face. For instance, it can be
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2455 used to make the @code{default} face a variable-pitch face within a
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2456 particular buffer.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2457
95457
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2458 @defvar face-remapping-alist
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2459 An alist whose elements have the form @code{(@var{face}
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2460 @var{remapping...})}. This causes Emacs to display text using the
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2461 face @var{face} using @var{remapping...} instead of @var{face}'s
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2462 ordinary definition. @var{remapping...} may be any face specification
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2463 suitable for a @code{face} text property: either a face name, or a
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2464 property list of attribute/value pairs. @xref{Special Properties}.
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2465
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2466 If @code{face-remapping-alist} is buffer-local, its local value takes
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2467 effect only within that buffer.
95457
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2468
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2469 Two points bear emphasizing:
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2470
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2471 @enumerate
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2472 @item
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2473 The new definition @var{remapping...} is the complete
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2474 specification of how to display @var{face}---it entirely replaces,
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2475 rather than augmenting or modifying, the normal definition of that
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2476 face.
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2477
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2478 @item
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2479 If @var{remapping...} recursively references the same face name
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2480 @var{face}, either directly remapping entry, or via the
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2481 @code{:inherit} attribute of some other face in @var{remapping...},
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2482 then that reference uses the normal definition of @var{face} in the
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2483 selected frame, instead of the ``remapped'' definition.
95457
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2484
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2485 For instance, if the @code{mode-line} face is remapped using this
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2486 entry in @code{face-remapping-alist}:
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2487 @example
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2488 (mode-line italic mode-line)
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2489 @end example
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2490 @noindent
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2491 then the new definition of the @code{mode-line} face inherits from the
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2492 @code{italic} face, and the @emph{normal} (non-remapped) definition of
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2493 @code{mode-line} face.
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2494 @end enumerate
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2495 @end defvar
95457
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2496
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2497 A typical use of the @code{face-remapping-alist} is to change a
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2498 buffer's @code{default} face; for example, the following changes a
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2499 buffer's @code{default} face to use the @code{variable-pitch} face,
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2500 with the height doubled:
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2501
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2502 @example
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2503 (set (make-local-variable 'face-remapping-alist)
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2504 '((default variable-pitch :height 2.0)))
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2505 @end example
415f68458e61 Implement face-remapping-alist feature
Miles Bader <miles@gnu.org>
parents: 94197
diff changeset
2506
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2507 The following functions implement a higher-level interface to
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2508 @code{face-remapping-alist}, making it easier to use
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2509 ``cooperatively''. They are mainly intended for buffer-local use, and
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2510 so all make @code{face-remapping-alist} variable buffer-local as a
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2511 side-effect. They use entries in @code{face-remapping-alist} which
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
2512 have the general form:
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2513
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2514 @example
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2515 (@var{face} @var{relative_specs_1} @var{relative_specs_2} @var{...} @var{base_specs})
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2516 @end example
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2517
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2518 Everything except @var{face} is a ``face spec'': a list of face names
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2519 or face attribute-value pairs. All face specs are merged together,
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
2520 with earlier values taking precedence.
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2521
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2522 The @var{relative_specs_}n values are ``relative specs'', and are
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2523 added by @code{face-remap-add-relative} (and removed by
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2524 @code{face-remap-remove-relative}. These are intended for face
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2525 modifications (such as increasing the size). Typical users of these
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2526 relative specs would be minor modes.
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2527
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2528 @var{base_specs} is the lowest-priority value, and by default is just the
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2529 face name, which causes the global definition of that face to be used.
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2530
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2531 A non-default value of @var{base_specs} may also be set using
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2532 @code{face-remap-set-base}. Because this @emph{overwrites} the
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2533 default base-spec value (which inherits the global face definition),
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2534 it is up to the caller of @code{face-remap-set-base} to add such
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2535 inheritance if it is desired. A typical use of
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2536 @code{face-remap-set-base} would be a major mode adding a face
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2537 remappings, e.g., of the default face.
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2538
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2539
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2540 @defun face-remap-add-relative face &rest specs
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2541 This functions adds a face remapping entry of @var{face} to @var{specs}
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2542 in the current buffer.
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2543
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2544 It returns a ``cookie'' which can be used to later delete the remapping with
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2545 @code{face-remap-remove-relative}.
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2546
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2547 @var{specs} can be any value suitable for the @code{face} text
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2548 property, including a face name, a list of face names, or a
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2549 face-attribute property list. The attributes given by @var{specs}
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2550 will be merged with any other currently active face remappings of
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2551 @var{face}, and with the global definition of @var{face} (by default;
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2552 this may be changed using @code{face-remap-set-base}), with the most
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2553 recently added relative remapping taking precedence.
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2554 @end defun
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2555
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2556 @defun face-remap-remove-relative cookie
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2557 This function removes a face remapping previously added by
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2558 @code{face-remap-add-relative}. @var{cookie} should be a return value
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2559 from that function.
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2560 @end defun
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2561
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2562 @defun face-remap-set-base face &rest specs
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2563 This function sets the ``base remapping'' of @var{face} in the current
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2564 buffer to @var{specs}. If @var{specs} is empty, the default base
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2565 remapping is restored, which inherits from the global definition of
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2566 @var{face}; note that this is different from @var{specs} containing a
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2567 single value @code{nil}, which has the opposite result (the global
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2568 definition of @var{face} is ignored).
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2569 @end defun
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2570
95563
6d9c4248a579 Rename functions in lisp/face-remap.el
Miles Bader <miles@gnu.org>
parents: 95553
diff changeset
2571 @defun face-remap-reset-base face
95515
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2572 This function sets the ``base remapping'' of @var{face} to its default
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2573 value, which inherits from @var{face}'s global definition.
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2574 @end defun
328f63bafded Add lisp/face-remap.el and associated documentation
Miles Bader <miles@gnu.org>
parents: 95457
diff changeset
2575
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2576 @node Face Functions
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2577 @subsection Functions for Working with Faces
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2578
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2579 Here are additional functions for creating and working with faces.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2580
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2581 @defun make-face name
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2582 This function defines a new face named @var{name}, initially with all
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2583 attributes @code{nil}. It does nothing if there is already a face named
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2584 @var{name}.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2585 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2586
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2587 @defun face-list
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2588 This function returns a list of all defined face names.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2589 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2590
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2591 @defun copy-face old-face new-name &optional frame new-frame
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2592 This function defines a face named @var{new-name} as a copy of the existing
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2593 face named @var{old-face}. It creates the face @var{new-name} if that
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2594 doesn't already exist.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2595
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2596 If the optional argument @var{frame} is given, this function applies
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2597 only to that frame. Otherwise it applies to each frame individually,
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2598 copying attributes from @var{old-face} in each frame to @var{new-face}
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2599 in the same frame.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2600
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2601 If the optional argument @var{new-frame} is given, then @code{copy-face}
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2602 copies the attributes of @var{old-face} in @var{frame} to @var{new-name}
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2603 in @var{new-frame}.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2604 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2605
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2606 @defun face-id face
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2607 This function returns the @dfn{face number} of face @var{face}. This
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2608 is a number that uniquely identifies a face at low levels within
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2609 Emacs. It is seldom necessary to refer to a face by its face number.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2610 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2611
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2612 @defun face-documentation face
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2613 This function returns the documentation string of face @var{face}, or
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2614 @code{nil} if none was specified for it.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2615 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2616
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2617 @defun face-equal face1 face2 &optional frame
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2618 This returns @code{t} if the faces @var{face1} and @var{face2} have the
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2619 same attributes for display.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2620 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2621
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2622 @defun face-differs-from-default-p face &optional frame
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2623 This returns non-@code{nil} if the face @var{face} displays
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2624 differently from the default face.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2625 @end defun
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2626
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2627 @cindex face alias
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2628 A @dfn{face alias} provides an equivalent name for a face. You can
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2629 define a face alias by giving the alias symbol the @code{face-alias}
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2630 property, with a value of the target face name. The following example
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2631 makes @code{modeline} an alias for the @code{mode-line} face.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2632
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2633 @example
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2634 (put 'modeline 'face-alias 'mode-line)
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2635 @end example
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2636
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2637 @node Auto Faces
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2638 @subsection Automatic Face Assignment
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2639 @cindex automatic face assignment
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2640 @cindex faces, automatic choice
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2641
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2642 This hook is used for automatically assigning faces to text in the
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2643 buffer. It is part of the implementation of Jit-Lock mode, used by
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2644 Font-Lock.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2645
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2646 @defvar fontification-functions
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2647 This variable holds a list of functions that are called by Emacs
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2648 redisplay as needed to assign faces automatically to text in the buffer.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2649
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2650 The functions are called in the order listed, with one argument, a
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2651 buffer position @var{pos}. Each function should attempt to assign faces
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2652 to the text in the current buffer starting at @var{pos}.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2653
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2654 Each function should record the faces they assign by setting the
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2655 @code{face} property. It should also add a non-@code{nil}
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2656 @code{fontified} property for all the text it has assigned faces to.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2657 That property tells redisplay that faces have been assigned to that text
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2658 already.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2659
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2660 It is probably a good idea for each function to do nothing if the
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2661 character after @var{pos} already has a non-@code{nil} @code{fontified}
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2662 property, but this is not required. If one function overrides the
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2663 assignments made by a previous one, the properties as they are
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2664 after the last function finishes are the ones that really matter.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2665
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2666 For efficiency, we recommend writing these functions so that they
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2667 usually assign faces to around 400 to 600 characters at each call.
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2668 @end defvar
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2669
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2670 @node Font Selection
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2671 @subsection Font Selection
100990
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2672
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2673 Before Emacs can draw a character on a particular display, it must
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2674 select a @dfn{font} for that character@footnote{In this context, the
80faf5dfb6cd (Faces): Put Font Selection node after Auto Faces.
Chong Yidong <cyd@stupidchicken.com>
parents: 100978
diff changeset
2675 term @dfn{font} has nothing to do with Font Lock (@pxref{Font Lock
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2676 Mode}).}. Normally, Emacs automatically chooses a font based on the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2677 faces assigned to that character---specifically, the face attributes
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2678 @code{:family}, @code{:weight}, @code{:slant}, and @code{:width}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2679 (@pxref{Face Attributes}). The choice of font also depends on the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2680 character to be displayed; some fonts can only display a limited set
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2681 of characters. If no available font exactly fits the requirements,
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2682 Emacs looks for the @dfn{closest matching font}. The variables in
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2683 this section control how Emacs makes this selection.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2684
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2685 @defopt face-font-family-alternatives
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2686 If a given family is specified but does not exist, this variable
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2687 specifies alternative font families to try. Each element should have
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2688 this form:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691 (@var{family} @var{alternate-families}@dots{})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 If @var{family} is specified but not available, Emacs will try the other
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695 families given in @var{alternate-families}, one by one, until it finds a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 family that does exist.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2697 @end defopt
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2698
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2699 @defopt face-font-selection-order
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2700 If there is no font that exactly matches all desired face attributes
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2701 (@code{:width}, @code{:height}, @code{:weight}, and @code{:slant}),
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2702 this variable specifies the order in which these attributes should be
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2703 considered when selecting the closest matching font. The value should
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2704 be a list containing those four attribute symbols, in order of
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2705 decreasing importance. The default is @code{(:width :height :weight
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2706 :slant)}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2707
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2708 Font selection first finds the best available matches for the first
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2709 attribute in the list; then, among the fonts which are best in that
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2710 way, it searches for the best matches in the second attribute, and so
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2711 on.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2712
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2713 The attributes @code{:weight} and @code{:width} have symbolic values in
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2714 a range centered around @code{normal}. Matches that are more extreme
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2715 (farther from @code{normal}) are somewhat preferred to matches that are
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2716 less extreme (closer to @code{normal}); this is designed to ensure that
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2717 non-normal faces contrast with normal ones, whenever possible.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2718
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2719 One example of a case where this variable makes a difference is when the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2720 default font has no italic equivalent. With the default ordering, the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2721 @code{italic} face will use a non-italic font that is similar to the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2722 default one. But if you put @code{:slant} before @code{:height}, the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2723 @code{italic} face will use an italic font, even if its height is not
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2724 quite right.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2725 @end defopt
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2726
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2727 @defopt face-font-registry-alternatives
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2728 This variable lets you specify alternative font registries to try, if a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2729 given registry is specified and doesn't exist. Each element should have
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2730 this form:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2733 (@var{registry} @var{alternate-registries}@dots{})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 If @var{registry} is specified but not available, Emacs will try the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2737 other registries given in @var{alternate-registries}, one by one,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738 until it finds a registry that does exist.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2739 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2740
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2741 Emacs can make use of scalable fonts, but by default it does not use
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2742 them.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2744 @defopt scalable-fonts-allowed
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 This variable controls which scalable fonts to use. A value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746 @code{nil}, the default, means do not use scalable fonts. @code{t}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747 means to use any scalable font that seems appropriate for the text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 Otherwise, the value must be a list of regular expressions. Then a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 scalable font is enabled for use if its name matches any regular
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751 expression in the list. For example,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 (setq scalable-fonts-allowed '("muleindian-2$"))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758 allows the use of scalable fonts with registry @code{muleindian-2}.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
2759 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761 @defvar face-font-rescale-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2762 This variable specifies scaling for certain faces. Its value should
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 be a list of elements of the form
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2765 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766 (@var{fontname-regexp} . @var{scale-factor})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2768
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2769 If @var{fontname-regexp} matches the font name that is about to be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2770 used, this says to choose a larger similar font according to the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2771 factor @var{scale-factor}. You would use this feature to normalize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2772 the font size if certain fonts are bigger or smaller than their
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 nominal heights and widths would suggest.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776 @node Font Lookup
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 @subsection Looking Up Fonts
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778
101289
fb88ce222846 (Font Lookup): Document WIDTH argument of x-list-fonts.
Chong Yidong <cyd@stupidchicken.com>
parents: 101140
diff changeset
2779 @defun x-list-fonts name &optional reference-face frame maximum width
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780 This function returns a list of available font names that match
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2781 @var{name}. @var{name} should be a string containing a font name in
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2782 either the Fontconfig, GTK, or XLFD format (@pxref{Font X,, Font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2783 Specification Options, emacs, The GNU Emacs Manual}). Within an XLFD
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2784 string, wildcard characters may be used: the @samp{*} character
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2785 matches any substring, and the @samp{?} character matches any single
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2786 character. Case is ignored when matching font names.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2787
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2788 If the optional arguments @var{reference-face} and @var{frame} are
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2789 specified, the returned list includes only fonts that are the same
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2790 size as @var{reference-face} (a face name) currently is on the frame
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2791 @var{frame}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 The optional argument @var{maximum} sets a limit on how many fonts to
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2794 return. If it is non-@code{nil}, then the return value is truncated
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2795 after the first @var{maximum} matching fonts. Specifying a small
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2796 value for @var{maximum} can make this function much faster, in cases
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2797 where many fonts match the pattern.
101289
fb88ce222846 (Font Lookup): Document WIDTH argument of x-list-fonts.
Chong Yidong <cyd@stupidchicken.com>
parents: 101140
diff changeset
2798
fb88ce222846 (Font Lookup): Document WIDTH argument of x-list-fonts.
Chong Yidong <cyd@stupidchicken.com>
parents: 101140
diff changeset
2799 The optional argument @var{width} specifies a desired font width. If
fb88ce222846 (Font Lookup): Document WIDTH argument of x-list-fonts.
Chong Yidong <cyd@stupidchicken.com>
parents: 101140
diff changeset
2800 it is non-@code{nil}, the function only returns those fonts whose
fb88ce222846 (Font Lookup): Document WIDTH argument of x-list-fonts.
Chong Yidong <cyd@stupidchicken.com>
parents: 101140
diff changeset
2801 characters are (on average) @var{width} times as wide as
fb88ce222846 (Font Lookup): Document WIDTH argument of x-list-fonts.
Chong Yidong <cyd@stupidchicken.com>
parents: 101140
diff changeset
2802 @var{reference-face}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805 @defun x-family-fonts &optional family frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806 This function returns a list describing the available fonts for family
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807 @var{family} on @var{frame}. If @var{family} is omitted or @code{nil},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2808 this list applies to all families, and therefore, it contains all
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2809 available fonts. Otherwise, @var{family} must be a string; it may
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 contain the wildcards @samp{?} and @samp{*}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 The list describes the display that @var{frame} is on; if @var{frame} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813 omitted or @code{nil}, it applies to the selected frame's display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 (@pxref{Input Focus}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2816 Each element in the list is a vector of the following form:
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 [@var{family} @var{width} @var{point-size} @var{weight} @var{slant}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 @var{fixed-p} @var{full} @var{registry-and-encoding}]
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 The first five elements correspond to face attributes; if you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824 specify these attributes for a face, it will use this font.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 The last three elements give additional information about the font.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 @var{fixed-p} is non-@code{nil} if the font is fixed-pitch.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828 @var{full} is the full name of the font, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 @var{registry-and-encoding} is a string giving the registry and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2830 encoding of the font.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833 @defvar font-list-limit
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 This variable specifies maximum number of fonts to consider in font
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 matching. The function @code{x-family-fonts} will not return more than
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 that many fonts, and font selection will consider only that many fonts
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 when searching a matching font for face attributes. The default is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838 currently 100.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 @node Fontsets
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 @subsection Fontsets
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 A @dfn{fontset} is a list of fonts, each assigned to a range of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 character codes. An individual font cannot display the whole range of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 characters that Emacs supports, but a fontset can. Fontsets have names,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 just as fonts do, and you can use a fontset name in place of a font name
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 when you specify the ``font'' for a frame or a face. Here is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849 information about defining a fontset under Lisp program control.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 @defun create-fontset-from-fontset-spec fontset-spec &optional style-variant-p noerror
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852 This function defines a new fontset according to the specification
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853 string @var{fontset-spec}. The string should have this format:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855 @smallexample
95553
9145bbb09578 (Fontsets): Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 95515
diff changeset
2856 @var{fontpattern}, @r{[}@var{charset}:@var{font}@r{]@dots{}}
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2857 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2858
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2859 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2860 Whitespace characters before and after the commas are ignored.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2861
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 The first part of the string, @var{fontpattern}, should have the form of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863 a standard X font name, except that the last two fields should be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864 @samp{fontset-@var{alias}}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866 The new fontset has two names, one long and one short. The long name is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867 @var{fontpattern} in its entirety. The short name is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 @samp{fontset-@var{alias}}. You can refer to the fontset by either
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869 name. If a fontset with the same name already exists, an error is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2870 signaled, unless @var{noerror} is non-@code{nil}, in which case this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 function does nothing.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873 If optional argument @var{style-variant-p} is non-@code{nil}, that says
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874 to create bold, italic and bold-italic variants of the fontset as well.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 These variant fontsets do not have a short name, only a long one, which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876 is made by altering @var{fontpattern} to indicate the bold or italic
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877 status.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879 The specification string also says which fonts to use in the fontset.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 See below for the details.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 The construct @samp{@var{charset}:@var{font}} specifies which font to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884 use (in this fontset) for one particular character set. Here,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 @var{charset} is the name of a character set, and @var{font} is the font
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 to use for that character set. You can use this construct any number of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887 times in the specification string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 For the remaining character sets, those that you don't specify
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 explicitly, Emacs chooses a font based on @var{fontpattern}: it replaces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891 @samp{fontset-@var{alias}} with a value that names one character set.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 For the @acronym{ASCII} character set, @samp{fontset-@var{alias}} is replaced
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 with @samp{ISO8859-1}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895 In addition, when several consecutive fields are wildcards, Emacs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 collapses them into a single wildcard. This is to prevent use of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897 auto-scaled fonts. Fonts made by scaling larger fonts are not usable
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 for editing, and scaling a smaller font is not useful because it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 better to use the smaller font in its own size, which Emacs does.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 Thus if @var{fontpattern} is this,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2908 the font specification for @acronym{ASCII} characters would be this:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 and the font specification for Chinese GB2312 characters would be this:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921 You may not have any Chinese font matching the above font
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 specification. Most X distributions include only Chinese fonts that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923 have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924 such a case, @samp{Fontset-@var{n}} can be specified as below:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2932 Then, the font specifications for all but Chinese GB2312 characters have
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933 @samp{fixed} in the @var{family} field, and the font specification for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934 Chinese GB2312 characters has a wild card @samp{*} in the @var{family}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 field.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936
102515
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2937 @defun set-fontset-font name character font-spec &optional frame add
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2938 This function modifies the existing fontset @var{name} to use the font
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2939 matching with @var{font-spec} for the character @var{character}.
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2940
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2941 If @var{name} is @code{nil}, this function modifies the fontset of the
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2942 selected frame or that of @var{frame} if @var{frame} is not
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2943 @code{nil}.
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2944
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2945 If @var{name} is @code{t}, this function modifies the default
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 fontset, whose short name is @samp{fontset-default}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948 @var{character} may be a cons; @code{(@var{from} . @var{to})}, where
98709
c5da883d1e87 (Fontsets): Don't mention generic characters.
Eli Zaretskii <eliz@gnu.org>
parents: 98267
diff changeset
2949 @var{from} and @var{to} are character codepoints. In that case, use
102515
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2950 @var{font-spec} for all characters in the range @var{from} and @var{to}
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 (inclusive).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953 @var{character} may be a charset. In that case, use
102515
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2954 @var{font-spec} for all character in the charsets.
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2955
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2956 @var{character} may be a script anme. In that case, use
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2957 @var{font-spec} for all character in the charsets.
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2958
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2959 @var{font-spec} may be a cons; @code{(@var{family} . @var{registry})},
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 where @var{family} is a family name of a font (possibly including a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961 foundry name at the head), @var{registry} is a registry name of a font
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 (possibly including an encoding name at the tail).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963
102515
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2964 @var{font-spec} may be a font name string.
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2965
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2966 The optional argument @var{add}, if non-@code{nil}, specifies how to
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2967 add @var{font-spec} to the font specifications previously set. If it
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2968 is @code{prepend}, @var{font-spec} is prepended. If it is
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2969 @code{append}, @var{font-spec} is appended. By default,
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2970 @var{font-spec} overrides the previous settings.
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2971
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 For instance, this changes the default fontset to use a font of which
102515
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2973 family name is @samp{Kochi Gothic} for all characters belonging to
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 the charset @code{japanese-jisx0208}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 @smallexample
102515
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2977 (set-fontset-font t 'japanese-jisx0208
34182d9c3399 (Fontsets): Update the description.
Kenichi Handa <handa@m17n.org>
parents: 102409
diff changeset
2978 (font-spec :family "Kochi Gothic"))
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 @defun char-displayable-p char
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983 This function returns @code{t} if Emacs ought to be able to display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 @var{char}. More precisely, if the selected frame's fontset has a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985 font to display the character set that @var{char} belongs to.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2987 Fontsets can specify a font on a per-character basis; when the fontset
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988 does that, this function's value may not be accurate.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2989 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2991 @node Low-Level Font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2992 @subsection Low-Level Font Representation
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2993
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2994 Normally, it is not necessary to manipulate fonts directly. In case
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2995 you need to do so, this section explains how.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2996
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2997 In Emacs Lisp, fonts are represented using three different Lisp
101140
d4a656ae8ace * display.texi (Low-Level Font): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 101069
diff changeset
2998 object types: @dfn{font objects}, @dfn{font specs}, and @dfn{font
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
2999 entities}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3000
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3001 @defun fontp object &optional type
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3002 Return @code{t} if @var{object} is a font object, font spec, or font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3003 entity. Otherwise, return @code{nil}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3004
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3005 The optional argument @var{type}, if non-@code{nil}, determines the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3006 exact type of Lisp object to check for. In that case, @var{type}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3007 should be one of @code{font-object}, @code{font-spec}, or
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3008 @code{font-entity}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3009 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3010
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3011 A font object is a Lisp object that represents a font that Emacs has
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3012 @dfn{opened}. Font objects cannot be modified in Lisp, but they can
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3013 be inspected.
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3014
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3015 @defun font-at position &optional window string
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3016 Return the font object that is being used to display the character at
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3017 position @var{position} in the window @var{window}. If @var{window}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3018 is @code{nil}, it defaults to the selected window. If @var{string} is
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3019 @code{nil}, @var{position} specifies a position in the current buffer;
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3020 otherwise, @var{string} should be a string, and @var{position}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3021 specifies a position in that string.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3022 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3023
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3024 A font spec is a Lisp object that contains a set of specifications
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3025 that can be used to find a font. More than one font may match the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3026 specifications in a font spec.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3027
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3028 @defun font-spec &rest arguments
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3029 Return a new font spec using the specifications in @var{arguments},
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3030 which should come in @code{property}-@code{value} pairs. The possible
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3031 specifications are as follows:
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3032
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3033 @table @code
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3034 @item :name
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3035 The font name (a string), in either XLFD, Fontconfig, or GTK format.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3036 @xref{Font X,, Font Specification Options, emacs, The GNU Emacs
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3037 Manual}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3038
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3039 @item :family
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3040 @itemx :foundry
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3041 @itemx :weight
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3042 @itemx :slant
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3043 @itemx :width
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3044 These have the same meanings as the face attributes of the same name.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3045 @xref{Face Attributes}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3046
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3047 @item :size
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3048 The font size---either a non-negative integer that specifies the pixel
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3049 size, or a floating point number that specifies the point size.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3050
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3051 @item :adstyle
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3052 Additional typographic style information for the font, such as
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3053 @samp{sans}. The value should be a string or a symbol.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3054
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3055 @item :registry
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3056 The charset registry and encoding of the font, such as
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3057 @samp{iso8859-1}. The value should be a string or a symbol.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3058
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3059 @item :script
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3060 The script that the font must support (a symbol).
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3061 @end table
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3062 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3063
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3064 @defun font-put font-spec property value
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3065 Set the font property @var{property} in the font-spec @var{font-spec}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3066 to @var{value}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3067 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3068
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3069 A font entity is a reference to a font that need not be open. Its
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3070 properties are intermediate between a font object and a font spec:
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3071 like a font object, and unlike a font spec, it refers to a single,
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3072 specific font. Unlike a font object, creating a font entity does not
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3073 load the contents of that font into computer memory.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3074
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3075 @defun find-font font-spec &optional frame
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3076 This function returns a font entity that best matches the font spec
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3077 @var{font-spec} on frame @var{frame}. If @var{frame} is @code{nil},
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3078 it defaults to the selected frame.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3079 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3080
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3081 @defun list-fonts font-spec &optional frame num prefer
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3082 This function returns a list of all font entities that match the font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3083 spec @var{font-spec}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3084
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3085 The optional argument @var{frame}, if non-@code{nil}, specifies the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3086 frame on which the fonts are to be displayed. The optional argument
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3087 @var{num}, if non-@code{nil}, should be an integer that specifies the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3088 maximum length of the returned list. The optional argument
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3089 @var{prefer}, if non-@code{nil}, should be another font spec, which is
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3090 used to control the order of the returned list; the returned font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3091 entities are sorted in order of decreasing ``closeness'' to that font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3092 spec.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3093 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3094
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3095 If you call @code{set-face-attribute} and pass a font spec, font
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3096 entity, or font name string as the value of the @code{:font}
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3097 attribute, Emacs opens the best ``matching'' font that is available
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3098 for display. It then stores the corresponding font object as the
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3099 actual value of the @code{:font} attribute for that face.
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
3100
101033
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3101 The following functions can be used to obtain information about a
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3102 font. For these functions, the @var{font} argument can be a font
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3103 object, a font entity, or a font spec.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3104
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3105 @defun font-get font property
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3106 This function returns the value of the font property @var{property}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3107 for @var{font}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3108
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3109 If @var{font} is a font spec and the font spec does not specify
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3110 @var{property}, the return value is @code{nil}. If @var{font} is a
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3111 font object or font entity, the value for the @var{:script} property
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3112 may be a list of scripts supported by the font.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3113 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3114
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3115 @defun font-face-attributes font &optional frame
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3116 This function returns a list of face attributes corresponding to
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3117 @var{font}. The optional argument @var{frame} specifies the frame on
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3118 which the font is to be displayed. If it is @code{nil}, the selected
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3119 frame is used. The return value has the form
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3120
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3121 @smallexample
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3122 (:family @var{family} :height @var{height} :weight @var{weight}
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3123 :slant @var{slant} :width @var{width})
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3124 @end smallexample
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3125
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3126 where the values of @var{family}, @var{height}, @var{weight},
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3127 @var{slant}, and @var{width} are face attribute values. Some of these
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3128 key-attribute pairs may be omitted from the list if they are not
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3129 specified by @var{font}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3130 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3131
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3132 @defun font-xlfd-name font &optional fold-wildcards
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3133 This function returns the XLFD (X Logical Font Descriptor), a string,
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3134 matching @var{font}. @xref{Font X,, Font Specification Options,
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3135 emacs, The GNU Emacs Manual}, for information about XLFDs. If the
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3136 name is too long for an XLFD (which can contain at most 255
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3137 characters), the function returns @code{nil}.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3138
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3139 If the optional argument @var{fold-wildcards} is non-@code{nil},
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3140 consecutive wildcards in the XLFD are folded into one.
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3141 @end defun
652cf1b0fd5a (Font Lookup): Remove obsolete function
Chong Yidong <cyd@stupidchicken.com>
parents: 100990
diff changeset
3142
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 @node Fringes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144 @section Fringes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3145 @cindex fringes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3146
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3147 The @dfn{fringes} of a window are thin vertical strips down the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3148 sides that are used for displaying bitmaps that indicate truncation,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3149 continuation, horizontal scrolling, and the overlay arrow.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3152 * Fringe Size/Pos:: Specifying where to put the window fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3153 * Fringe Indicators:: Displaying indicator icons in the window fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3154 * Fringe Cursors:: Displaying cursors in the right fringe.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3155 * Fringe Bitmaps:: Specifying bitmaps for fringe indicators.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3156 * Customizing Bitmaps:: Specifying your own bitmaps to use in the fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3157 * Overlay Arrow:: Display of an arrow to indicate position.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3158 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3159
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3160 @node Fringe Size/Pos
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3161 @subsection Fringe Size and Position
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3162
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3163 The following buffer-local variables control the position and width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3164 of the window fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3165
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3166 @defvar fringes-outside-margins
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3167 The fringes normally appear between the display margins and the window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3168 text. If the value is non-@code{nil}, they appear outside the display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3169 margins. @xref{Display Margins}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3170 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3172 @defvar left-fringe-width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 This variable, if non-@code{nil}, specifies the width of the left
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3174 fringe in pixels. A value of @code{nil} means to use the left fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175 width from the window's frame.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178 @defvar right-fringe-width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 This variable, if non-@code{nil}, specifies the width of the right
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 fringe in pixels. A value of @code{nil} means to use the right fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 width from the window's frame.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3183
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184 The values of these variables take effect when you display the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 buffer in a window. If you change them while the buffer is visible,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3186 you can call @code{set-window-buffer} to display it once again in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187 same window, to make the changes take effect.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189 @defun set-window-fringes window left &optional right outside-margins
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3190 This function sets the fringe widths of window @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3191 If @var{window} is @code{nil}, the selected window is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 The argument @var{left} specifies the width in pixels of the left
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 fringe, and likewise @var{right} for the right fringe. A value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195 @code{nil} for either one stands for the default width. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3196 @var{outside-margins} is non-@code{nil}, that specifies that fringes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197 should appear outside of the display margins.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3198 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3199
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3200 @defun window-fringes &optional window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3201 This function returns information about the fringes of a window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3202 @var{window}. If @var{window} is omitted or @code{nil}, the selected
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3203 window is used. The value has the form @code{(@var{left-width}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3204 @var{right-width} @var{outside-margins})}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3205 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3206
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3207
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3208 @node Fringe Indicators
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3209 @subsection Fringe Indicators
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3210 @cindex fringe indicators
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3211 @cindex indicators, fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3212
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3213 The @dfn{fringe indicators} are tiny icons Emacs displays in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3214 window fringe (on a graphic display) to indicate truncated or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3215 continued lines, buffer boundaries, overlay arrow, etc.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3216
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3217 @defopt indicate-empty-lines
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3218 @cindex fringes, and empty line indication
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3219 When this is non-@code{nil}, Emacs displays a special glyph in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3220 fringe of each empty line at the end of the buffer, on graphical
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3221 displays. @xref{Fringes}. This variable is automatically
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3222 buffer-local in every buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3223 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3224
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
3225 @defopt indicate-buffer-boundaries
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3226 This buffer-local variable controls how the buffer boundaries and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3227 window scrolling are indicated in the window fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3228
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3229 Emacs can indicate the buffer boundaries---that is, the first and last
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3230 line in the buffer---with angle icons when they appear on the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3231 In addition, Emacs can display an up-arrow in the fringe to show
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3232 that there is text above the screen, and a down-arrow to show
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3233 there is text below the screen.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3234
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3235 There are three kinds of basic values:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3236
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3237 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3238 @item @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3239 Don't display any of these fringe icons.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3240 @item @code{left}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3241 Display the angle icons and arrows in the left fringe.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3242 @item @code{right}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3243 Display the angle icons and arrows in the right fringe.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3244 @item any non-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245 Display the angle icons in the left fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3246 and don't display the arrows.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3247 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3248
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3249 Otherwise the value should be an alist that specifies which fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3250 indicators to display and where. Each element of the alist should
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251 have the form @code{(@var{indicator} . @var{position})}. Here,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252 @var{indicator} is one of @code{top}, @code{bottom}, @code{up},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253 @code{down}, and @code{t} (which covers all the icons not yet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254 specified), while @var{position} is one of @code{left}, @code{right}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255 and @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 For example, @code{((top . left) (t . right))} places the top angle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 bitmap in left fringe, and the bottom angle bitmap as well as both
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3259 arrow bitmaps in right fringe. To show the angle bitmaps in the left
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3260 fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
3261 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263 @defvar default-indicate-buffer-boundaries
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 The value of this variable is the default value for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265 @code{indicate-buffer-boundaries} in buffers that do not override it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268 @defvar fringe-indicator-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3269 This buffer-local variable specifies the mapping from logical fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3270 indicators to the actual bitmaps displayed in the window fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3271
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 These symbols identify the logical fringe indicators:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275 @item Truncation and continuation line indicators:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3276 @code{truncation}, @code{continuation}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3278 @item Buffer position indicators:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3279 @code{up}, @code{down},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280 @code{top}, @code{bottom},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281 @code{top-bottom}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3282
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3283 @item Empty line indicator:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3284 @code{empty-line}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286 @item Overlay arrow indicator:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3287 @code{overlay-arrow}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3288
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3289 @item Unknown bitmap indicator:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3290 @code{unknown}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3291 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3292
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3293 The value is an alist where each element @code{(@var{indicator} . @var{bitmaps})}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3294 specifies the fringe bitmaps used to display a specific logical
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3295 fringe indicator.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3296
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3297 Here, @var{indicator} specifies the logical indicator type, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3298 @var{bitmaps} is list of symbols @code{(@var{left} @var{right}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3299 [@var{left1} @var{right1}])} which specifies the actual bitmap shown
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3300 in the left or right fringe for the logical indicator.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3301
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3302 The @var{left} and @var{right} symbols specify the bitmaps shown in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3303 the left and/or right fringe for the specific indicator. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3304 @var{left1} or @var{right1} bitmaps are used only for the `bottom' and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3305 `top-bottom indicators when the last (only) line in has no final
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3306 newline. Alternatively, @var{bitmaps} may be a single symbol which is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3307 used in both left and right fringes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3308
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3309 When @code{fringe-indicator-alist} has a buffer-local value, and there
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3310 is no bitmap defined for a logical indicator, or the bitmap is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3311 @code{t}, the corresponding value from the (non-local)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3312 @code{default-fringe-indicator-alist} is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3313
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3314 To completely hide a specific indicator, set the bitmap to @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3315 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3316
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3317 @defvar default-fringe-indicator-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3318 The value of this variable is the default value for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3319 @code{fringe-indicator-alist} in buffers that do not override it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3320 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3321
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3322 Standard fringe bitmaps for indicators:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3323 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3324 left-arrow right-arrow up-arrow down-arrow
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3325 left-curly-arrow right-curly-arrow
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3326 left-triangle right-triangle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3327 top-left-angle top-right-angle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3328 bottom-left-angle bottom-right-angle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3329 left-bracket right-bracket
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3330 filled-rectangle hollow-rectangle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3331 filled-square hollow-square
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3332 vertical-bar horizontal-bar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3333 empty-line question-mark
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3334 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3335
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3336 @node Fringe Cursors
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3337 @subsection Fringe Cursors
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3338 @cindex fringe cursors
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3339 @cindex cursor, fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3340
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3341 When a line is exactly as wide as the window, Emacs displays the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3342 cursor in the right fringe instead of using two lines. Different
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3343 bitmaps are used to represent the cursor in the fringe depending on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3344 the current buffer's cursor type.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3345
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3346 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3347 @item Logical cursor types:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3348 @code{box} , @code{hollow}, @code{bar},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3349 @code{hbar}, @code{hollow-small}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3350 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3351
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3352 The @code{hollow-small} type is used instead of @code{hollow} when the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3353 normal @code{hollow-rectangle} bitmap is too tall to fit on a specific
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3354 display line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3355
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
3356 @defopt overflow-newline-into-fringe
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3357 If this is non-@code{nil}, lines exactly as wide as the window (not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3358 counting the final newline character) are not continued. Instead,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3359 when point is at the end of the line, the cursor appears in the right
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3360 fringe.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
3361 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3362
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3363 @defvar fringe-cursor-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3364 This variable specifies the mapping from logical cursor type to the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3365 actual fringe bitmaps displayed in the right fringe. The value is an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3366 alist where each element @code{(@var{cursor} . @var{bitmap})} specifies
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3367 the fringe bitmaps used to display a specific logical cursor type in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3368 the fringe. Here, @var{cursor} specifies the logical cursor type and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3369 @var{bitmap} is a symbol specifying the fringe bitmap to be displayed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3370 for that logical cursor type.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3371
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3372 When @code{fringe-cursor-alist} has a buffer-local value, and there is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3373 no bitmap defined for a cursor type, the corresponding value from the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3374 (non-local) @code{default-fringes-indicator-alist} is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3375 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3376
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3377 @defvar default-fringes-cursor-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3378 The value of this variable is the default value for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3379 @code{fringe-cursor-alist} in buffers that do not override it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3380 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3381
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3382 Standard bitmaps for displaying the cursor in right fringe:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3383 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3384 filled-rectangle hollow-rectangle filled-square hollow-square
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3385 vertical-bar horizontal-bar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3386 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3387
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3388
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3389 @node Fringe Bitmaps
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3390 @subsection Fringe Bitmaps
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3391 @cindex fringe bitmaps
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3392 @cindex bitmaps, fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3393
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3394 The @dfn{fringe bitmaps} are the actual bitmaps which represent the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3395 logical fringe indicators for truncated or continued lines, buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3396 boundaries, overlay arrow, etc. Fringe bitmap symbols have their own
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3397 name space. The fringe bitmaps are shared by all frames and windows.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3398 You can redefine the built-in fringe bitmaps, and you can define new
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3399 fringe bitmaps.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3400
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3401 The way to display a bitmap in the left or right fringes for a given
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3402 line in a window is by specifying the @code{display} property for one
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3403 of the characters that appears in it. Use a display specification of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3404 the form @code{(left-fringe @var{bitmap} [@var{face}])} or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3405 @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3406 Property}). Here, @var{bitmap} is a symbol identifying the bitmap you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3407 want, and @var{face} (which is optional) is the name of the face whose
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3408 colors should be used for displaying the bitmap, instead of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3409 default @code{fringe} face. @var{face} is automatically merged with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3410 the @code{fringe} face, so normally @var{face} need only specify the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3411 foreground color for the bitmap.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3412
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3413 @defun fringe-bitmaps-at-pos &optional pos window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3414 This function returns the fringe bitmaps of the display line
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3415 containing position @var{pos} in window @var{window}. The return
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3416 value has the form @code{(@var{left} @var{right} @var{ov})}, where @var{left}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3417 is the symbol for the fringe bitmap in the left fringe (or @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3418 if no bitmap), @var{right} is similar for the right fringe, and @var{ov}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3419 is non-@code{nil} if there is an overlay arrow in the left fringe.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3420
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3421 The value is @code{nil} if @var{pos} is not visible in @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3422 If @var{window} is @code{nil}, that stands for the selected window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3423 If @var{pos} is @code{nil}, that stands for the value of point in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3424 @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3425 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3426
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3427 @node Customizing Bitmaps
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3428 @subsection Customizing Fringe Bitmaps
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3429
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3430 @defun define-fringe-bitmap bitmap bits &optional height width align
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3431 This function defines the symbol @var{bitmap} as a new fringe bitmap,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3432 or replaces an existing bitmap with that name.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3433
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3434 The argument @var{bits} specifies the image to use. It should be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3435 either a string or a vector of integers, where each element (an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3436 integer) corresponds to one row of the bitmap. Each bit of an integer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3437 corresponds to one pixel of the bitmap, where the low bit corresponds
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3438 to the rightmost pixel of the bitmap.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3439
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3440 The height is normally the length of @var{bits}. However, you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3441 can specify a different height with non-@code{nil} @var{height}. The width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3442 is normally 8, but you can specify a different width with non-@code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3443 @var{width}. The width must be an integer between 1 and 16.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3444
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3445 The argument @var{align} specifies the positioning of the bitmap
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3446 relative to the range of rows where it is used; the default is to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3447 center the bitmap. The allowed values are @code{top}, @code{center},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3448 or @code{bottom}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3449
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3450 The @var{align} argument may also be a list @code{(@var{align}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3451 @var{periodic})} where @var{align} is interpreted as described above.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3452 If @var{periodic} is non-@code{nil}, it specifies that the rows in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3453 @code{bits} should be repeated enough times to reach the specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3454 height.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3455 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3456
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3457 @defun destroy-fringe-bitmap bitmap
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3458 This function destroy the fringe bitmap identified by @var{bitmap}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3459 If @var{bitmap} identifies a standard fringe bitmap, it actually
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3460 restores the standard definition of that bitmap, instead of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3461 eliminating it entirely.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3462 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3463
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3464 @defun set-fringe-bitmap-face bitmap &optional face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3465 This sets the face for the fringe bitmap @var{bitmap} to @var{face}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3466 If @var{face} is @code{nil}, it selects the @code{fringe} face. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3467 bitmap's face controls the color to draw it in.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3468
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3469 @var{face} is merged with the @code{fringe} face, so normally
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3470 @var{face} should specify only the foreground color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3471 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3472
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3473 @node Overlay Arrow
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3474 @subsection The Overlay Arrow
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3475 @c @cindex overlay arrow Duplicates variable names
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3476
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3477 The @dfn{overlay arrow} is useful for directing the user's attention
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3478 to a particular line in a buffer. For example, in the modes used for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3479 interface to debuggers, the overlay arrow indicates the line of code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3480 about to be executed. This feature has nothing to do with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3481 @dfn{overlays} (@pxref{Overlays}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3482
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3483 @defvar overlay-arrow-string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3484 This variable holds the string to display to call attention to a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3485 particular line, or @code{nil} if the arrow feature is not in use.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3486 On a graphical display the contents of the string are ignored; instead a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3487 glyph is displayed in the fringe area to the left of the display area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3488 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3489
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3490 @defvar overlay-arrow-position
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3491 This variable holds a marker that indicates where to display the overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3492 arrow. It should point at the beginning of a line. On a non-graphical
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3493 display the arrow text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3494 appears at the beginning of that line, overlaying any text that would
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3495 otherwise appear. Since the arrow is usually short, and the line
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3496 usually begins with indentation, normally nothing significant is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3497 overwritten.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3498
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3499 The overlay-arrow string is displayed in any given buffer if the value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500 of @code{overlay-arrow-position} in that buffer points into that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 buffer. Thus, it is possible to display multiple overlay arrow strings
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3502 by creating buffer-local bindings of @code{overlay-arrow-position}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3503 However, it is usually cleaner to use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3504 @code{overlay-arrow-variable-list} to achieve this result.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3505 @c !!! overlay-arrow-position: but the overlay string may remain in the display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3506 @c of some other buffer until an update is required. This should be fixed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3507 @c now. Is it?
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3508 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3509
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510 You can do a similar job by creating an overlay with a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3511 @code{before-string} property. @xref{Overlay Properties}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3512
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3513 You can define multiple overlay arrows via the variable
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3514 @code{overlay-arrow-variable-list}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3515
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3516 @defvar overlay-arrow-variable-list
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517 This variable's value is a list of variables, each of which specifies
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518 the position of an overlay arrow. The variable
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 @code{overlay-arrow-position} has its normal meaning because it is on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3520 this list.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3523 Each variable on this list can have properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 @code{overlay-arrow-string} and @code{overlay-arrow-bitmap} that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525 specify an overlay arrow string (for text-only terminals) or fringe
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3526 bitmap (for graphical terminals) to display at the corresponding
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3527 overlay arrow position. If either property is not set, the default
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3528 @code{overlay-arrow-string} or @code{overlay-arrow} fringe indicator
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3529 is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3530
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531 @node Scroll Bars
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 @section Scroll Bars
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3533 @cindex scroll bars
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3534
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3535 Normally the frame parameter @code{vertical-scroll-bars} controls
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3536 whether the windows in the frame have vertical scroll bars, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3537 whether they are on the left or right. The frame parameter
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3538 @code{scroll-bar-width} specifies how wide they are (@code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3539 meaning the default). @xref{Layout Parameters}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3540
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3541 @defun frame-current-scroll-bars &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3542 This function reports the scroll bar type settings for frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3543 @var{frame}. The value is a cons cell
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3544 @code{(@var{vertical-type} .@: @var{horizontal-type})}, where
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3545 @var{vertical-type} is either @code{left}, @code{right}, or @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3546 (which means no scroll bar.) @var{horizontal-type} is meant to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3547 specify the horizontal scroll bar type, but since they are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3548 implemented, it is always @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3549 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3550
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3551 @vindex vertical-scroll-bar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3552 You can enable or disable scroll bars for a particular buffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3553 by setting the variable @code{vertical-scroll-bar}. This variable
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3554 automatically becomes buffer-local when set. The possible values are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3555 @code{left}, @code{right}, @code{t}, which means to use the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3556 frame's default, and @code{nil} for no scroll bar.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3557
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3558 You can also control this for individual windows. Call the function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3559 @code{set-window-scroll-bars} to specify what to do for a specific window:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3560
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3561 @defun set-window-scroll-bars window width &optional vertical-type horizontal-type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3562 This function sets the width and type of scroll bars for window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3563 @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3564
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3565 @var{width} specifies the scroll bar width in pixels (@code{nil} means
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3566 use the width specified for the frame). @var{vertical-type} specifies
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3567 whether to have a vertical scroll bar and, if so, where. The possible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3568 values are @code{left}, @code{right} and @code{nil}, just like the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3569 values of the @code{vertical-scroll-bars} frame parameter.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3570
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3571 The argument @var{horizontal-type} is meant to specify whether and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3572 where to have horizontal scroll bars, but since they are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3573 implemented, it has no effect. If @var{window} is @code{nil}, the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3574 selected window is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3575 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3576
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3577 @defun window-scroll-bars &optional window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3578 Report the width and type of scroll bars specified for @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3579 If @var{window} is omitted or @code{nil}, the selected window is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3580 The value is a list of the form @code{(@var{width}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581 @var{cols} @var{vertical-type} @var{horizontal-type})}. The value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582 @var{width} is the value that was specified for the width (which may
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3583 be @code{nil}); @var{cols} is the number of columns that the scroll
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3584 bar actually occupies.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3585
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3586 @var{horizontal-type} is not actually meaningful.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589 If you don't specify these values for a window with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590 @code{set-window-scroll-bars}, the buffer-local variables
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591 @code{scroll-bar-mode} and @code{scroll-bar-width} in the buffer being
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592 displayed control the window's vertical scroll bars. The function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3593 @code{set-window-buffer} examines these variables. If you change them
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3594 in a buffer that is already visible in a window, you can make the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3595 window take note of the new values by calling @code{set-window-buffer}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3596 specifying the same buffer that is already displayed.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3597
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
3598 @defopt scroll-bar-mode
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3599 This variable, always local in all buffers, controls whether and where
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3600 to put scroll bars in windows displaying the buffer. The possible values
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3601 are @code{nil} for no scroll bar, @code{left} to put a scroll bar on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3602 the left, and @code{right} to put a scroll bar on the right.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 102981
diff changeset
3603 @end defopt
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3604
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3605 @defun window-current-scroll-bars &optional window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3606 This function reports the scroll bar type for window @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3607 If @var{window} is omitted or @code{nil}, the selected window is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3608 The value is a cons cell
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3609 @code{(@var{vertical-type} .@: @var{horizontal-type})}. Unlike
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3610 @code{window-scroll-bars}, this reports the scroll bar type actually
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3611 used, once frame defaults and @code{scroll-bar-mode} are taken into
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3612 account.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3613 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3614
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3615 @defvar scroll-bar-width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3616 This variable, always local in all buffers, specifies the width of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3617 buffer's scroll bars, measured in pixels. A value of @code{nil} means
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3618 to use the value specified by the frame.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621 @node Display Property
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3622 @section The @code{display} Property
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 @cindex display specification
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3624 @kindex display @r{(text property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3626 The @code{display} text property (or overlay property) is used to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3627 insert images into text, and also control other aspects of how text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3628 displays. The value of the @code{display} property should be a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3629 display specification, or a list or vector containing several display
85311
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3630 specifications. Display specifications in the same @code{display}
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3631 property value generally apply in parallel to the text they cover.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3632
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3633 If several sources (overlays and/or a text property) specify values
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3634 for the @code{display} property, only one of the values takes effect,
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3635 following the rules of @code{get-char-property}. @xref{Examining
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3636 Properties}.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3637
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3638 The rest of this section describes several kinds of
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3639 display specifications and what they mean.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3640
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3641 @menu
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3642 * Replacing Specs:: Display specs that replace the text.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3643 * Specified Space:: Displaying one space with a specified width.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3644 * Pixel Specification:: Specifying space width or height in pixels.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3645 * Other Display Specs:: Displaying an image; magnifying text; moving it
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3646 up or down on the page; adjusting the width
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3647 of spaces within text.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3648 * Display Margins:: Displaying text or images to the side of the main text.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3649 @end menu
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3650
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3651 @node Replacing Specs
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3652 @subsection Display Specs That Replace The Text
85114
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85048
diff changeset
3653
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85048
diff changeset
3654 Some kinds of @code{display} specifications specify something to
85311
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3655 display instead of the text that has the property. These are called
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3656 @dfn{replacing} display specifications. Emacs does not allow the user
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3657 to interactively move point into the middle of buffer text that is
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3658 replaced in this way.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3659
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3660 If a list of display specifications includes more than one replacing
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3661 display specification, the first overrides the rest. Replacing
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3662 display specifications make most other display specifications
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3663 irrelevant, since those don't apply to the replacement.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3664
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3665 For replacing display specifications, ``the text that has the
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3666 property'' means all the consecutive characters that have the same
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3667 Lisp object as their @code{display} property; these characters are
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3668 replaced as a single unit. By contrast, characters that have similar
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3669 but distinct Lisp objects as their @code{display} properties are
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3670 handled separately. Here's a function that illustrates this point:
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3671
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3672 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3673 (defun foo ()
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3674 (goto-char (point-min))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3675 (dotimes (i 5)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3676 (let ((string (concat "A")))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3677 (put-text-property (point) (1+ (point)) 'display string)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3678 (forward-char 1)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3679 (put-text-property (point) (1+ (point)) 'display string)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3680 (forward-char 1))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3681 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3682
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3683 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3684 It gives each of the first ten characters in the buffer string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 @code{"A"} as the @code{display} property, but they don't all get the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3686 same string. The first two characters get the same string, so they
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3687 together are replaced with one @samp{A}. The next two characters get
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3688 a second string, so they together are replaced with one @samp{A}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3689 Likewise for each following pair of characters. Thus, the ten
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690 characters appear as five A's. This function would have the same
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 results:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3692
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3693 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3694 (defun foo ()
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3695 (goto-char (point-min))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3696 (dotimes (i 5)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3697 (let ((string (concat "A")))
85114
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85048
diff changeset
3698 (put-text-property (point) (+ 2 (point)) 'display string)
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3699 (put-text-property (point) (1+ (point)) 'display string)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3700 (forward-char 2))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3701 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3702
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3703 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3704 This illustrates that what matters is the property value for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3705 each character. If two consecutive characters have the same
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3706 object as the @code{display} property value, it's irrelevant
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3707 whether they got this property from a single call to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3708 @code{put-text-property} or from two different calls.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3709
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3710 @node Specified Space
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3711 @subsection Specified Spaces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3712 @cindex spaces, specified height or width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3713 @cindex variable-width spaces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3714
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3715 To display a space of specified width and/or height, use a display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 specification of the form @code{(space . @var{props})}, where
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717 @var{props} is a property list (a list of alternating properties and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718 values). You can put this property on one or more consecutive
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3719 characters; a space of the specified height and width is displayed in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3720 place of @emph{all} of those characters. These are the properties you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 can use in @var{props} to specify the weight of the space:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3724 @item :width @var{width}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 If @var{width} is an integer or floating point number, it specifies
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3726 that the space width should be @var{width} times the normal character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3727 width. @var{width} can also be a @dfn{pixel width} specification
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728 (@pxref{Pixel Specification}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3729
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3730 @item :relative-width @var{factor}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3731 Specifies that the width of the stretch should be computed from the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732 first character in the group of consecutive characters that have the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733 same @code{display} property. The space width is the width of that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 character, multiplied by @var{factor}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3736 @item :align-to @var{hpos}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3737 Specifies that the space should be wide enough to reach @var{hpos}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3738 If @var{hpos} is a number, it is measured in units of the normal
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3739 character width. @var{hpos} can also be a @dfn{pixel width}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3740 specification (@pxref{Pixel Specification}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3741 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3743 You should use one and only one of the above properties. You can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 also specify the height of the space, with these properties:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747 @item :height @var{height}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3748 Specifies the height of the space.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3749 If @var{height} is an integer or floating point number, it specifies
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750 that the space height should be @var{height} times the normal character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751 height. The @var{height} may also be a @dfn{pixel height} specification
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752 (@pxref{Pixel Specification}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3754 @item :relative-height @var{factor}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755 Specifies the height of the space, multiplying the ordinary height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756 of the text having this display specification by @var{factor}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3757
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758 @item :ascent @var{ascent}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759 If the value of @var{ascent} is a non-negative number no greater than
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3760 100, it specifies that @var{ascent} percent of the height of the space
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3761 should be considered as the ascent of the space---that is, the part
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3762 above the baseline. The ascent may also be specified in pixel units
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3763 with a @dfn{pixel ascent} specification (@pxref{Pixel Specification}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3764
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3765 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3766
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3767 Don't use both @code{:height} and @code{:relative-height} together.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3768
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3769 The @code{:width} and @code{:align-to} properties are supported on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3770 non-graphic terminals, but the other space properties in this section
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3771 are not.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3772
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3773 @node Pixel Specification
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3774 @subsection Pixel Specification for Spaces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3775 @cindex spaces, pixel specification
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3776
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3777 The value of the @code{:width}, @code{:align-to}, @code{:height},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3778 and @code{:ascent} properties can be a special kind of expression that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3779 is evaluated during redisplay. The result of the evaluation is used
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3780 as an absolute number of pixels.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3781
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3782 The following expressions are supported:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3783
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3786 @var{expr} ::= @var{num} | (@var{num}) | @var{unit} | @var{elem} | @var{pos} | @var{image} | @var{form}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3787 @var{num} ::= @var{integer} | @var{float} | @var{symbol}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3788 @var{unit} ::= in | mm | cm | width | height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3789 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3790 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3791 @var{elem} ::= left-fringe | right-fringe | left-margin | right-margin
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3792 | scroll-bar | text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3793 @var{pos} ::= left | center | right
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794 @var{form} ::= (@var{num} . @var{expr}) | (@var{op} @var{expr} ...)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3795 @var{op} ::= + | -
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3796 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3797 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3798
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3799 The form @var{num} specifies a fraction of the default frame font
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3800 height or width. The form @code{(@var{num})} specifies an absolute
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3801 number of pixels. If @var{num} is a symbol, @var{symbol}, its
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3802 buffer-local variable binding is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3803
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3804 The @code{in}, @code{mm}, and @code{cm} units specify the number of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3805 pixels per inch, millimeter, and centimeter, respectively. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3806 @code{width} and @code{height} units correspond to the default width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3807 and height of the current face. An image specification @code{image}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3808 corresponds to the width or height of the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3809
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3810 The @code{left-fringe}, @code{right-fringe}, @code{left-margin},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3811 @code{right-margin}, @code{scroll-bar}, and @code{text} elements
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3812 specify to the width of the corresponding area of the window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3813
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3814 The @code{left}, @code{center}, and @code{right} positions can be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3815 used with @code{:align-to} to specify a position relative to the left
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3816 edge, center, or right edge of the text area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3817
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3818 Any of the above window elements (except @code{text}) can also be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3819 used with @code{:align-to} to specify that the position is relative to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3820 the left edge of the given area. Once the base offset for a relative
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3821 position has been set (by the first occurrence of one of these
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3822 symbols), further occurrences of these symbols are interpreted as the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3823 width of the specified area. For example, to align to the center of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824 the left-margin, use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 :align-to (+ left-margin (0.5 . left-margin))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 If no specific base offset is set for alignment, it is always relative
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 to the left edge of the text area. For example, @samp{:align-to 0} in a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832 header-line aligns with the first text column in the text area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3834 A value of the form @code{(@var{num} . @var{expr})} stands for the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835 product of the values of @var{num} and @var{expr}. For example,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 @code{(2 . in)} specifies a width of 2 inches, while @code{(0.5 .
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837 @var{image})} specifies half the width (or height) of the specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838 image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840 The form @code{(+ @var{expr} ...)} adds up the value of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841 expressions. The form @code{(- @var{expr} ...)} negates or subtracts
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 the value of the expressions.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844 @node Other Display Specs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3845 @subsection Other Display Specifications
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3846
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3847 Here are the other sorts of display specifications that you can use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3848 in the @code{display} text property.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3849
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3851 @item @var{string}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 Display @var{string} instead of the text that has this property.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3854 Recursive display specifications are not supported---@var{string}'s
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3855 @code{display} properties, if any, are not used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3856
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3857 @item (image . @var{image-props})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858 This kind of display specification is an image descriptor (@pxref{Images}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 When used as a display specification, it means to display the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860 instead of the text that has the display specification.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 @item (slice @var{x} @var{y} @var{width} @var{height})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 This specification together with @code{image} specifies a @dfn{slice}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864 (a partial area) of the image to display. The elements @var{y} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 @var{x} specify the top left corner of the slice, within the image;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 @var{width} and @var{height} specify the width and height of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 slice. Integer values are numbers of pixels. A floating point number
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 in the range 0.0--1.0 stands for that fraction of the width or height
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869 of the entire image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3870
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3871 @item ((margin nil) @var{string})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3872 A display specification of this form means to display @var{string}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3873 instead of the text that has the display specification, at the same
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3874 position as that text. It is equivalent to using just @var{string},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3875 but it is done as a special case of marginal display (@pxref{Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3876 Margins}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3877
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3878 @item (space-width @var{factor})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3879 This display specification affects all the space characters within the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3880 text that has the specification. It displays all of these spaces
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3881 @var{factor} times as wide as normal. The element @var{factor} should
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3882 be an integer or float. Characters other than spaces are not affected
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3883 at all; in particular, this has no effect on tab characters.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3884
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3885 @item (height @var{height})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3886 This display specification makes the text taller or shorter.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3887 Here are the possibilities for @var{height}:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3888
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3889 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3890 @item @code{(+ @var{n})}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3891 This means to use a font that is @var{n} steps larger. A ``step'' is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3892 defined by the set of available fonts---specifically, those that match
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3893 what was otherwise specified for this text, in all attributes except
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3894 height. Each size for which a suitable font is available counts as
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3895 another step. @var{n} should be an integer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3896
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3897 @item @code{(- @var{n})}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3898 This means to use a font that is @var{n} steps smaller.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3899
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3900 @item a number, @var{factor}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3901 A number, @var{factor}, means to use a font that is @var{factor} times
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3902 as tall as the default font.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3903
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3904 @item a symbol, @var{function}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3905 A symbol is a function to compute the height. It is called with the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3906 current height as argument, and should return the new height to use.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3907
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3908 @item anything else, @var{form}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3909 If the @var{height} value doesn't fit the previous possibilities, it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3910 a form. Emacs evaluates it to get the new height, with the symbol
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3911 @code{height} bound to the current specified font height.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3912 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3913
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3914 @item (raise @var{factor})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3915 This kind of display specification raises or lowers the text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3916 it applies to, relative to the baseline of the line.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3917
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3918 @var{factor} must be a number, which is interpreted as a multiple of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3919 height of the affected text. If it is positive, that means to display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3920 the characters raised. If it is negative, that means to display them
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3921 lower down.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3922
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3923 If the text also has a @code{height} display specification, that does
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3924 not affect the amount of raising or lowering, which is based on the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3925 faces used for the text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3926 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3927
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3928 @c We put all the `@code{(when ...)}' on one line to encourage
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3929 @c makeinfo's end-of-sentence heuristics to DTRT. Previously, the dot
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3930 @c was at eol; the info file ended up w/ two spaces rendered after it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3931 You can make any display specification conditional. To do that,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3932 package it in another list of the form
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3933 @code{(when @var{condition} . @var{spec})}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3934 Then the specification @var{spec} applies only when
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3935 @var{condition} evaluates to a non-@code{nil} value. During the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3936 evaluation, @code{object} is bound to the string or buffer having the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937 conditional @code{display} property. @code{position} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3938 @code{buffer-position} are bound to the position within @code{object}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3939 and the buffer position where the @code{display} property was found,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3940 respectively. Both positions can be different when @code{object} is a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3943 @node Display Margins
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3944 @subsection Displaying in the Margins
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3945 @cindex display margins
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3946 @cindex margins, display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3947
85311
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3948 A buffer can have blank areas called @dfn{display margins} on the
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3949 left and on the right. Ordinary text never appears in these areas,
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3950 but you can put things into the display margins using the
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3951 @code{display} property. There is currently no way to make text or
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3952 images in the margin mouse-sensitive.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3953
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3954 The way to display something in the margins is to specify it in a
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3955 margin display specification in the @code{display} property of some
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3956 text. This is a replacing display specification, meaning that the
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3957 text you put it on does not get displayed; the margin display appears,
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3958 but that text does not.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3959
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3960 A margin display specification looks like @code{((margin
102409
1559b2b91761 John Foerch <jjfoerch at earthlink.net> (tiny change)
Glenn Morris <rgm@gnu.org>
parents: 101443
diff changeset
3961 right-margin) @var{spec})} or @code{((margin left-margin) @var{spec})}.
85311
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3962 Here, @var{spec} is another display specification that says what to
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3963 display in the margin. Typically it is a string of text to display,
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3964 or an image descriptor.
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3965
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3966 To display something in the margin @emph{in association with}
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3967 certain buffer text, without altering or preventing the display of
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3968 that text, put a @code{before-string} property on the text and put the
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
3969 margin display specification on the contents of the before-string.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3970
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3971 Before the display margins can display anything, you must give
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3972 them a nonzero width. The usual way to do that is to set these
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3973 variables:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3974
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3975 @defvar left-margin-width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3976 This variable specifies the width of the left margin.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3977 It is buffer-local in all buffers.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3978 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3979
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3980 @defvar right-margin-width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3981 This variable specifies the width of the right margin.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982 It is buffer-local in all buffers.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3983 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3984
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 Setting these variables does not immediately affect the window. These
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3986 variables are checked when a new buffer is displayed in the window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3987 Thus, you can make changes take effect by calling
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3988 @code{set-window-buffer}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990 You can also set the margin widths immediately.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3991
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3992 @defun set-window-margins window left &optional right
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3993 This function specifies the margin widths for window @var{window}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994 The argument @var{left} controls the left margin and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995 @var{right} controls the right margin (default @code{0}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3998 @defun window-margins &optional window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3999 This function returns the left and right margins of @var{window}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4000 as a cons cell of the form @code{(@var{left} . @var{right})}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001 If @var{window} is @code{nil}, the selected window is used.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4004 @node Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005 @section Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006 @cindex images in buffers
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4008 To display an image in an Emacs buffer, you must first create an image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 descriptor, then use it as a display specifier in the @code{display}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010 property of text that is displayed (@pxref{Display Property}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4011
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 Emacs is usually able to display images when it is run on a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013 graphical terminal. Images cannot be displayed in a text terminal, on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4014 certain graphical terminals that lack the support for this, or if
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4015 Emacs is compiled without image support. You can use the function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016 @code{display-images-p} to determine if images can in principle be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 displayed (@pxref{Display Feature Testing}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020 * Image Formats:: Supported image formats.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4021 * Image Descriptors:: How to specify an image for use in @code{:display}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4022 * XBM Images:: Special features for XBM format.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023 * XPM Images:: Special features for XPM format.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 * GIF Images:: Special features for GIF format.
97725
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4025 * TIFF Images:: Special features for TIFF format.
101069
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4026 * PostScript Images:: Special features for PostScript format.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4027 * Other Image Types:: Various other formats are supported.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4028 * Defining Images:: Convenient ways to define an image for later use.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029 * Showing Images:: Convenient ways to display an image once it is defined.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030 * Image Cache:: Internal mechanisms of image display.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4032
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4033 @node Image Formats
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034 @subsection Image Formats
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 @cindex image formats
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036 @cindex image types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4038 Emacs can display a number of different image formats; some of them
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4039 are supported only if particular support libraries are installed on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040 your machine. In some environments, Emacs can load image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4041 libraries on demand; if so, the variable @code{image-library-alist}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 can be used to modify the set of known names for these dynamic
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043 libraries (though it is not possible to add new image formats).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045 The supported image formats include XBM, XPM (this requires the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047 @code{libungif} 4.1.0), PostScript, PBM, JPEG (requiring the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 @code{libjpeg} library version v6a), TIFF (requiring @code{libtiff}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4049 v3.4), PNG (requiring @code{libpng} 1.0.2), and SVG (requiring
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4050 @code{librsvg} 2.0.0).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4051
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4052 You specify one of these formats with an image type symbol. The image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 type symbols are @code{xbm}, @code{xpm}, @code{gif}, @code{postscript},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054 @code{pbm}, @code{jpeg}, @code{tiff}, @code{png}, and @code{svg}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 @defvar image-types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 This variable contains a list of those image type symbols that are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 potentially supported in the current configuration.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059 @emph{Potentially} here means that Emacs knows about the image types,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4060 not necessarily that they can be loaded (they could depend on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4061 unavailable dynamic libraries, for example).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 To know which image types are really available, use
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064 @code{image-type-available-p}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4066
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067 @defvar image-library-alist
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 This in an alist of image types vs external libraries needed to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 display them.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4071 Each element is a list @code{(@var{image-type} @var{library}...)},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4072 where the car is a supported image format from @code{image-types}, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4073 the rest are strings giving alternate filenames for the corresponding
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074 external libraries to load.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4076 Emacs tries to load the libraries in the order they appear on the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4077 list; if none is loaded, the running session of Emacs won't support
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 the image type. @code{pbm} and @code{xbm} don't need to be listed;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079 they're always supported.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4080
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 This variable is ignored if the image libraries are statically linked
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 into Emacs.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4083 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4084
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4085 @defun image-type-available-p type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086 This function returns non-@code{nil} if image type @var{type} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 available, i.e., if images of this type can be loaded and displayed in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 Emacs. @var{type} should be one of the types contained in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089 @code{image-types}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091 For image types whose support libraries are statically linked, this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 function always returns @code{t}; for other image types, it returns
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093 @code{t} if the dynamic library could be loaded, @code{nil} otherwise.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4094 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4095
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4096 @node Image Descriptors
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4097 @subsection Image Descriptors
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4098 @cindex image descriptor
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4099
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4100 An image description is a list of the form @code{(image . @var{props})},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 where @var{props} is a property list containing alternating keyword
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 symbols (symbols whose names start with a colon) and their values.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4103 You can use any Lisp object as a property, but the only properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4104 that have any special meaning are certain symbols, all of them keywords.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4105
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4106 Every image descriptor must contain the property @code{:type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4107 @var{type}} to specify the format of the image. The value of @var{type}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4108 should be an image type symbol; for example, @code{xpm} for an image in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4109 XPM format.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4110
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4111 Here is a list of other properties that are meaningful for all image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 types:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4113
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4114 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4115 @item :file @var{file}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4116 The @code{:file} property says to load the image from file
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4117 @var{file}. If @var{file} is not an absolute file name, it is expanded
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4118 in @code{data-directory}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4119
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4120 @item :data @var{data}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4121 The @code{:data} property says the actual contents of the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4122 Each image must use either @code{:data} or @code{:file}, but not both.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4123 For most image types, the value of the @code{:data} property should be a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4124 string containing the image data; we recommend using a unibyte string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4125
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4126 Before using @code{:data}, look for further information in the section
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4127 below describing the specific image format. For some image types,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4128 @code{:data} may not be supported; for some, it allows other data types;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4129 for some, @code{:data} alone is not enough, so you need to use other
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4130 image properties along with @code{:data}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4131
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4132 @item :margin @var{margin}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4133 The @code{:margin} property specifies how many pixels to add as an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4134 extra margin around the image. The value, @var{margin}, must be a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4135 non-negative number, or a pair @code{(@var{x} . @var{y})} of such
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4136 numbers. If it is a pair, @var{x} specifies how many pixels to add
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4137 horizontally, and @var{y} specifies how many pixels to add vertically.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4138 If @code{:margin} is not specified, the default is zero.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4139
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4140 @item :ascent @var{ascent}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4141 The @code{:ascent} property specifies the amount of the image's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4142 height to use for its ascent---that is, the part above the baseline.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4143 The value, @var{ascent}, must be a number in the range 0 to 100, or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4144 the symbol @code{center}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4145
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4146 If @var{ascent} is a number, that percentage of the image's height is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4147 used for its ascent.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4148
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4149 If @var{ascent} is @code{center}, the image is vertically centered
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4150 around a centerline which would be the vertical centerline of text drawn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4151 at the position of the image, in the manner specified by the text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4152 properties and overlays that apply to the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4153
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4154 If this property is omitted, it defaults to 50.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4155
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4156 @item :relief @var{relief}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4157 The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4158 around the image. The value, @var{relief}, specifies the width of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4159 shadow lines, in pixels. If @var{relief} is negative, shadows are drawn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4160 so that the image appears as a pressed button; otherwise, it appears as
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4161 an unpressed button.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4162
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4163 @item :conversion @var{algorithm}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4164 The @code{:conversion} property, if non-@code{nil}, specifies a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4165 conversion algorithm that should be applied to the image before it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4166 displayed; the value, @var{algorithm}, specifies which algorithm.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4167
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4168 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4169 @item laplace
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4170 @itemx emboss
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4171 Specifies the Laplace edge detection algorithm, which blurs out small
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4172 differences in color while highlighting larger differences. People
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4173 sometimes consider this useful for displaying the image for a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4174 ``disabled'' button.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4175
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4176 @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4177 Specifies a general edge-detection algorithm. @var{matrix} must be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4178 either a nine-element list or a nine-element vector of numbers. A pixel
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4179 at position @math{x/y} in the transformed image is computed from
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4180 original pixels around that position. @var{matrix} specifies, for each
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4181 pixel in the neighborhood of @math{x/y}, a factor with which that pixel
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4182 will influence the transformed pixel; element @math{0} specifies the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4183 factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4184 the pixel at @math{x/y-1} etc., as shown below:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4185 @iftex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4186 @tex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4187 $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4188 x-1/y & x/y & x+1/y \cr
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4189 x-1/y+1& x/y+1 & x+1/y+1 \cr}$$
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4190 @end tex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4191 @end iftex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4192 @ifnottex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4193 @display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4194 (x-1/y-1 x/y-1 x+1/y-1
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4195 x-1/y x/y x+1/y
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4196 x-1/y+1 x/y+1 x+1/y+1)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4197 @end display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4198 @end ifnottex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4199
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4200 The resulting pixel is computed from the color intensity of the color
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4201 resulting from summing up the RGB values of surrounding pixels,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4202 multiplied by the specified factors, and dividing that sum by the sum
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4203 of the factors' absolute values.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4204
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4205 Laplace edge-detection currently uses a matrix of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206 @iftex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207 @tex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4208 $$\pmatrix{1 & 0 & 0 \cr
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209 0& 0 & 0 \cr
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210 9 & 9 & -1 \cr}$$
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211 @end tex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 @end iftex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4213 @ifnottex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4214 @display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215 (1 0 0
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4216 0 0 0
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 9 9 -1)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218 @end display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219 @end ifnottex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221 Emboss edge-detection uses a matrix of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4222 @iftex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223 @tex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224 $$\pmatrix{ 2 & -1 & 0 \cr
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225 -1 & 0 & 1 \cr
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4226 0 & 1 & -2 \cr}$$
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 @end tex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228 @end iftex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4229 @ifnottex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 @display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4231 ( 2 -1 0
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232 -1 0 1
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 0 1 -2)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4234 @end display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4235 @end ifnottex
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4236
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4237 @item disabled
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 Specifies transforming the image so that it looks ``disabled.''
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4240
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4241 @item :mask @var{mask}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242 If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4243 a clipping mask for the image, so that the background of a frame is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244 visible behind the image. If @var{bg} is not specified, or if @var{bg}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245 is @code{t}, determine the background color of the image by looking at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246 the four corners of the image, assuming the most frequently occurring
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4247 color from the corners is the background color of the image. Otherwise,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4248 @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4249 specifying the color to assume for the background of the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251 If @var{mask} is @code{nil}, remove a mask from the image, if it has
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4252 one. Images in some formats include a mask which can be removed by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253 specifying @code{:mask nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4255 @item :pointer @var{shape}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4256 This specifies the pointer shape when the mouse pointer is over this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4257 image. @xref{Pointer Shape}, for available pointer shapes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 @item :map @var{map}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4260 This associates an image map of @dfn{hot spots} with this image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4261
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4262 An image map is an alist where each element has the format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4263 @code{(@var{area} @var{id} @var{plist})}. An @var{area} is specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4264 as either a rectangle, a circle, or a polygon.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4265
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4266 A rectangle is a cons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4267 @code{(rect . ((@var{x0} . @var{y0}) . (@var{x1} . @var{y1})))}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4268 which specifies the pixel coordinates of the upper left and bottom right
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269 corners of the rectangle area.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271 A circle is a cons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272 @code{(circle . ((@var{x0} . @var{y0}) . @var{r}))}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273 which specifies the center and the radius of the circle; @var{r} may
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 be a float or integer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276 A polygon is a cons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4277 @code{(poly . [@var{x0} @var{y0} @var{x1} @var{y1} ...])}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4278 where each pair in the vector describes one corner in the polygon.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4279
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4280 When the mouse pointer lies on a hot-spot area of an image, the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4281 @var{plist} of that hot-spot is consulted; if it contains a @code{help-echo}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4282 property, that defines a tool-tip for the hot-spot, and if it contains
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4283 a @code{pointer} property, that defines the shape of the mouse cursor when
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4284 it is on the hot-spot.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4285 @xref{Pointer Shape}, for available pointer shapes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4286
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4287 When you click the mouse when the mouse pointer is over a hot-spot, an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4288 event is composed by combining the @var{id} of the hot-spot with the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4289 mouse event; for instance, @code{[area4 mouse-1]} if the hot-spot's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4290 @var{id} is @code{area4}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4291 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4292
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4293 @defun image-mask-p spec &optional frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4294 This function returns @code{t} if image @var{spec} has a mask bitmap.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4295 @var{frame} is the frame on which the image will be displayed.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4296 @var{frame} @code{nil} or omitted means to use the selected frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4297 (@pxref{Input Focus}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4298 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4299
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4300 @node XBM Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4301 @subsection XBM Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4302 @cindex XBM
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4303
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4304 To use XBM format, specify @code{xbm} as the image type. This image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4305 format doesn't require an external library, so images of this type are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4306 always supported.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4307
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4308 Additional image properties supported for the @code{xbm} image type are:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4309
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4310 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4311 @item :foreground @var{foreground}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4312 The value, @var{foreground}, should be a string specifying the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4313 foreground color, or @code{nil} for the default color. This color is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4314 used for each pixel in the XBM that is 1. The default is the frame's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4315 foreground color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4316
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4317 @item :background @var{background}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4318 The value, @var{background}, should be a string specifying the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4319 background color, or @code{nil} for the default color. This color is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4320 used for each pixel in the XBM that is 0. The default is the frame's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4321 background color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4322 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4323
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4324 If you specify an XBM image using data within Emacs instead of an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4325 external file, use the following three properties:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4326
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4327 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4328 @item :data @var{data}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4329 The value, @var{data}, specifies the contents of the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4330 There are three formats you can use for @var{data}:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4331
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4332 @itemize @bullet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4333 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4334 A vector of strings or bool-vectors, each specifying one line of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4335 image. Do specify @code{:height} and @code{:width}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4336
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4337 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4338 A string containing the same byte sequence as an XBM file would contain.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4339 You must not specify @code{:height} and @code{:width} in this case,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4340 because omitting them is what indicates the data has the format of an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4341 XBM file. The file contents specify the height and width of the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4342
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4343 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4344 A string or a bool-vector containing the bits of the image (plus perhaps
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4345 some extra bits at the end that will not be used). It should contain at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4346 least @var{width} * @code{height} bits. In this case, you must specify
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4347 @code{:height} and @code{:width}, both to indicate that the string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4348 contains just the bits rather than a whole XBM file, and to specify the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4349 size of the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4350 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4351
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4352 @item :width @var{width}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4353 The value, @var{width}, specifies the width of the image, in pixels.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4354
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4355 @item :height @var{height}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4356 The value, @var{height}, specifies the height of the image, in pixels.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4357 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4358
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4359 @node XPM Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4360 @subsection XPM Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4361 @cindex XPM
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4362
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4363 To use XPM format, specify @code{xpm} as the image type. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4364 additional image property @code{:color-symbols} is also meaningful with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4365 the @code{xpm} image type:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4366
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4367 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4368 @item :color-symbols @var{symbols}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4369 The value, @var{symbols}, should be an alist whose elements have the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4370 form @code{(@var{name} . @var{color})}. In each element, @var{name} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4371 the name of a color as it appears in the image file, and @var{color}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4372 specifies the actual color to use for displaying that name.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4373 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4374
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4375 @node GIF Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4376 @subsection GIF Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4377 @cindex GIF
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4378
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4379 For GIF images, specify image type @code{gif}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4380
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4381 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4382 @item :index @var{index}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4383 You can use @code{:index} to specify one image from a GIF file that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4384 contains more than one image. This property specifies use of image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4385 number @var{index} from the file. If the GIF file doesn't contain an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4386 image with index @var{index}, the image displays as a hollow box.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4387 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4388
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4389 @ignore
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4390 This could be used to implement limited support for animated GIFs.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4391 For example, the following function displays a multi-image GIF file
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4392 at point-min in the current buffer, switching between sub-images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4393 every 0.1 seconds.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4394
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4395 (defun show-anim (file max)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4396 "Display multi-image GIF file FILE which contains MAX subimages."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4397 (display-anim (current-buffer) file 0 max t))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4398
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4399 (defun display-anim (buffer file idx max first-time)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4400 (when (= idx max)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4401 (setq idx 0))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4402 (let ((img (create-image file nil :image idx)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4403 (save-excursion
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4404 (set-buffer buffer)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4405 (goto-char (point-min))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4406 (unless first-time (delete-char 1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4407 (insert-image img))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4408 (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4409 @end ignore
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4410
97725
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4411 @node TIFF Images
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4412 @subsection TIFF Images
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4413 @cindex TIFF
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4414
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4415 For TIFF images, specify image type @code{tiff}.
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4416
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4417 @table @code
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4418 @item :index @var{index}
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4419 You can use @code{:index} to specify one image from a TIFF file that
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4420 contains more than one image. This property specifies use of image
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4421 number @var{index} from the file. If the TIFF file doesn't contain an
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4422 image with index @var{index}, the image displays as a hollow box.
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4423 @end table
7660589a4e25 (TIFF Images): New section describing :index property.
Jason Rumney <jasonr@gnu.org>
parents: 97627
diff changeset
4424
101069
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4425 @node PostScript Images
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4426 @subsection PostScript Images
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4427 @cindex postscript images
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4428
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4429 To use PostScript for an image, specify image type @code{postscript}.
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4430 This works only if you have Ghostscript installed. You must always use
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4431 these three properties:
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4432
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4433 @table @code
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4434 @item :pt-width @var{width}
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4435 The value, @var{width}, specifies the width of the image measured in
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4436 points (1/72 inch). @var{width} must be an integer.
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4437
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4438 @item :pt-height @var{height}
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4439 The value, @var{height}, specifies the height of the image in points
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4440 (1/72 inch). @var{height} must be an integer.
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4441
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4442 @item :bounding-box @var{box}
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4443 The value, @var{box}, must be a list or vector of four integers, which
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4444 specifying the bounding box of the PostScript image, analogous to the
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4445 @samp{BoundingBox} comment found in PostScript files.
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4446
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4447 @example
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4448 %%BoundingBox: 22 171 567 738
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4449 @end example
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4450 @end table
00eb4d86697f Undo last change.
Chong Yidong <cyd@stupidchicken.com>
parents: 101064
diff changeset
4451
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4452 @node Other Image Types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4453 @subsection Other Image Types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4454 @cindex PBM
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4455
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4456 For PBM images, specify image type @code{pbm}. Color, gray-scale and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4457 monochromatic images are supported. For mono PBM images, two additional
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4458 image properties are supported.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4459
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4460 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4461 @item :foreground @var{foreground}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4462 The value, @var{foreground}, should be a string specifying the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4463 foreground color, or @code{nil} for the default color. This color is
96396
e29e1bbed939 (Other Image Types): Fix copy/paste error; say "PBM", not "XBM".
Johan Bockgård <bojohan@gnu.org>
parents: 95563
diff changeset
4464 used for each pixel in the PBM that is 1. The default is the frame's
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4465 foreground color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4466
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4467 @item :background @var{background}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4468 The value, @var{background}, should be a string specifying the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4469 background color, or @code{nil} for the default color. This color is
96396
e29e1bbed939 (Other Image Types): Fix copy/paste error; say "PBM", not "XBM".
Johan Bockgård <bojohan@gnu.org>
parents: 95563
diff changeset
4470 used for each pixel in the PBM that is 0. The default is the frame's
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4471 background color.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4472 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4473
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4474 For JPEG images, specify image type @code{jpeg}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4475
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4476 For TIFF images, specify image type @code{tiff}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4477
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4478 For PNG images, specify image type @code{png}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4479
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4480 For SVG images, specify image type @code{svg}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4481
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4482 @node Defining Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4483 @subsection Defining Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4484
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4485 The functions @code{create-image}, @code{defimage} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4486 @code{find-image} provide convenient ways to create image descriptors.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4487
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4488 @defun create-image file-or-data &optional type data-p &rest props
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4489 This function creates and returns an image descriptor which uses the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4490 data in @var{file-or-data}. @var{file-or-data} can be a file name or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4491 a string containing the image data; @var{data-p} should be @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4492 for the former case, non-@code{nil} for the latter case.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4493
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4494 The optional argument @var{type} is a symbol specifying the image type.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4495 If @var{type} is omitted or @code{nil}, @code{create-image} tries to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4496 determine the image type from the file's first few bytes, or else
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4497 from the file's name.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4498
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4499 The remaining arguments, @var{props}, specify additional image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4500 properties---for example,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4501
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4502 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4503 (create-image "foo.xpm" 'xpm nil :heuristic-mask t)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4504 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4505
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4506 The function returns @code{nil} if images of this type are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4507 supported. Otherwise it returns an image descriptor.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4508 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4509
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4510 @defmac defimage symbol specs &optional doc
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4511 This macro defines @var{symbol} as an image name. The arguments
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4512 @var{specs} is a list which specifies how to display the image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4513 The third argument, @var{doc}, is an optional documentation string.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4514
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4515 Each argument in @var{specs} has the form of a property list, and each
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4516 one should specify at least the @code{:type} property and either the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4517 @code{:file} or the @code{:data} property. The value of @code{:type}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4518 should be a symbol specifying the image type, the value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4519 @code{:file} is the file to load the image from, and the value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4520 @code{:data} is a string containing the actual image data. Here is an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4521 example:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4522
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4523 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4524 (defimage test-image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4525 ((:type xpm :file "~/test1.xpm")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4526 (:type xbm :file "~/test1.xbm")))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4527 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4528
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4529 @code{defimage} tests each argument, one by one, to see if it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4530 usable---that is, if the type is supported and the file exists. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4531 first usable argument is used to make an image descriptor which is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4532 stored in @var{symbol}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4533
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4534 If none of the alternatives will work, then @var{symbol} is defined
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4535 as @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4536 @end defmac
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4537
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4538 @defun find-image specs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4539 This function provides a convenient way to find an image satisfying one
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4540 of a list of image specifications @var{specs}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4541
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4542 Each specification in @var{specs} is a property list with contents
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4543 depending on image type. All specifications must at least contain the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4544 properties @code{:type @var{type}} and either @w{@code{:file @var{file}}}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4545 or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4546 the image type, e.g.@: @code{xbm}, @var{file} is the file to load the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4547 image from, and @var{data} is a string containing the actual image data.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4548 The first specification in the list whose @var{type} is supported, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4549 @var{file} exists, is used to construct the image specification to be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4550 returned. If no specification is satisfied, @code{nil} is returned.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4551
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4552 The image is looked for in @code{image-load-path}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4553 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4554
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4555 @defvar image-load-path
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4556 This variable's value is a list of locations in which to search for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4557 image files. If an element is a string or a variable symbol whose
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4558 value is a string, the string is taken to be the name of a directory
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4559 to search. If an element is a variable symbol whose value is a list,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4560 that is taken to be a list of directory names to search.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4561
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4562 The default is to search in the @file{images} subdirectory of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4563 directory specified by @code{data-directory}, then the directory
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4564 specified by @code{data-directory}, and finally in the directories in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4565 @code{load-path}. Subdirectories are not automatically included in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4566 the search, so if you put an image file in a subdirectory, you have to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4567 supply the subdirectory name explicitly. For example, to find the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4568 image @file{images/foo/bar.xpm} within @code{data-directory}, you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4569 should specify the image as follows:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4570
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4571 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4572 (defimage foo-image '((:type xpm :file "foo/bar.xpm")))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4573 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4574 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4575
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4576 @defun image-load-path-for-library library image &optional path no-error
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4577 This function returns a suitable search path for images used by the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4578 Lisp package @var{library}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4579
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4580 The function searches for @var{image} first using @code{image-load-path},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4581 excluding @file{@code{data-directory}/images}, and then in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4582 @code{load-path}, followed by a path suitable for @var{library}, which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4583 includes @file{../../etc/images} and @file{../etc/images} relative to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4584 the library file itself, and finally in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4585 @file{@code{data-directory}/images}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4586
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4587 Then this function returns a list of directories which contains first
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4588 the directory in which @var{image} was found, followed by the value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4589 @code{load-path}. If @var{path} is given, it is used instead of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4590 @code{load-path}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4591
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4592 If @var{no-error} is non-@code{nil} and a suitable path can't be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4593 found, don't signal an error. Instead, return a list of directories as
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4594 before, except that @code{nil} appears in place of the image directory.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4595
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4596 Here is an example that uses a common idiom to provide compatibility
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4597 with versions of Emacs that lack the variable @code{image-load-path}:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4598
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4599 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4600 (defvar image-load-path) ; shush compiler
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4601 (let* ((load-path (image-load-path-for-library
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4602 "mh-e" "mh-logo.xpm"))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4603 (image-load-path (cons (car load-path)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4604 (when (boundp 'image-load-path)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4605 image-load-path))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4606 (mh-tool-bar-folder-buttons-init))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4607 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4608 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4609
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4610 @node Showing Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4611 @subsection Showing Images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4612
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4613 You can use an image descriptor by setting up the @code{display}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4614 property yourself, but it is easier to use the functions in this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4615 section.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4616
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4617 @defun insert-image image &optional string area slice
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4618 This function inserts @var{image} in the current buffer at point. The
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4619 value @var{image} should be an image descriptor; it could be a value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4620 returned by @code{create-image}, or the value of a symbol defined with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4621 @code{defimage}. The argument @var{string} specifies the text to put
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4622 in the buffer to hold the image. If it is omitted or @code{nil},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4623 @code{insert-image} uses @code{" "} by default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4624
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4625 The argument @var{area} specifies whether to put the image in a margin.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4626 If it is @code{left-margin}, the image appears in the left margin;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4627 @code{right-margin} specifies the right margin. If @var{area} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4628 @code{nil} or omitted, the image is displayed at point within the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4629 buffer's text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4630
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4631 The argument @var{slice} specifies a slice of the image to insert. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4632 @var{slice} is @code{nil} or omitted the whole image is inserted.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4633 Otherwise, @var{slice} is a list @code{(@var{x} @var{y} @var{width}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4634 @var{height})} which specifies the @var{x} and @var{y} positions and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4635 @var{width} and @var{height} of the image area to insert. Integer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4636 values are in units of pixels. A floating point number in the range
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4637 0.0--1.0 stands for that fraction of the width or height of the entire
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4638 image.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4639
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4640 Internally, this function inserts @var{string} in the buffer, and gives
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4641 it a @code{display} property which specifies @var{image}. @xref{Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4642 Property}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4643 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4644
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4645 @defun insert-sliced-image image &optional string area rows cols
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4646 This function inserts @var{image} in the current buffer at point, like
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4647 @code{insert-image}, but splits the image into @var{rows}x@var{cols}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4648 equally sized slices.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4649 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4650
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4651 @defun put-image image pos &optional string area
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4652 This function puts image @var{image} in front of @var{pos} in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4653 current buffer. The argument @var{pos} should be an integer or a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4654 marker. It specifies the buffer position where the image should appear.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4655 The argument @var{string} specifies the text that should hold the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4656 as an alternative to the default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4657
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4658 The argument @var{image} must be an image descriptor, perhaps returned
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4659 by @code{create-image} or stored by @code{defimage}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4660
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4661 The argument @var{area} specifies whether to put the image in a margin.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4662 If it is @code{left-margin}, the image appears in the left margin;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4663 @code{right-margin} specifies the right margin. If @var{area} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4664 @code{nil} or omitted, the image is displayed at point within the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4665 buffer's text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4666
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4667 Internally, this function creates an overlay, and gives it a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4668 @code{before-string} property containing text that has a @code{display}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4669 property whose value is the image. (Whew!)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4670 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4671
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4672 @defun remove-images start end &optional buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4673 This function removes images in @var{buffer} between positions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4674 @var{start} and @var{end}. If @var{buffer} is omitted or @code{nil},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4675 images are removed from the current buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4676
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4677 This removes only images that were put into @var{buffer} the way
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4678 @code{put-image} does it, not images that were inserted with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4679 @code{insert-image} or in other ways.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4680 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4681
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4682 @defun image-size spec &optional pixels frame
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4683 This function returns the size of an image as a pair
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4684 @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4685 specification. @var{pixels} non-@code{nil} means return sizes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4686 measured in pixels, otherwise return sizes measured in canonical
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4687 character units (fractions of the width/height of the frame's default
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4688 font). @var{frame} is the frame on which the image will be displayed.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4689 @var{frame} null or omitted means use the selected frame (@pxref{Input
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4690 Focus}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4691 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4692
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4693 @defvar max-image-size
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4694 This variable is used to define the maximum size of image that Emacs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4695 will load. Emacs will refuse to load (and display) any image that is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4696 larger than this limit.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4697
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4698 If the value is an integer, it directly specifies the maximum
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4699 image height and width, measured in pixels. If it is a floating
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4700 point number, it specifies the maximum image height and width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4701 as a ratio to the frame height and width. If the value is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4702 non-numeric, there is no explicit limit on the size of images.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4703
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4704 The purpose of this variable is to prevent unreasonably large images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4705 from accidentally being loaded into Emacs. It only takes effect the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4706 first time an image is loaded. Once an image is placed in the image
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4707 cache, it can always be displayed, even if the value of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4708 @var{max-image-size} is subsequently changed (@pxref{Image Cache}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4709 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4710
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4711 @node Image Cache
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4712 @subsection Image Cache
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4713 @cindex image cache
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4714
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4715 Emacs caches images so that it can display them again more
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4716 efficiently. When Emacs displays an image, it searches the image
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4717 cache for an existing image specification @code{equal} to the desired
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4718 specification. If a match is found, the image is displayed from the
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4719 cache; otherwise, Emacs loads the image normally.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4720
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4721 Occasionally, you may need to tell Emacs to refresh the images
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4722 associated with a given image specification. For example, suppose you
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4723 display an image using a specification that contains a @code{:file}
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4724 property. The image is automatically cached, and subsequent displays
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4725 of that image, with the same image specification, will use the image
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4726 cache. If the image file changes in the meantime, Emacs would be
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4727 displaying the old version of the image. In such a situation, you can
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4728 ``refresh'' the image by calling @code{image-refresh}.
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4729
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4730 In Emacs' current implementation, each graphical terminal possesses
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4731 an image cache, which is shared by all the frames on that terminal
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4732 (@pxref{Multiple Terminals}). Thus, refreshing an image in one frame
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4733 also refreshes it in all other frames on the same terminal.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4734
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4735 @defun image-refresh spec &optional frame
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4736 This function refreshes any images with image specifications
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4737 @code{equal} to @var{spec} on frame @var{frame}. If @var{frame} is
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4738 @code{nil}, it defaults to the selected frame. If @var{frame} is
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4739 @code{t}, the refresh is applied to all existing frames.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4740 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4741
92150
1c088baa9d2d Allow fine-grained image-cache flushing.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 88019
diff changeset
4742 @defun clear-image-cache &optional filter
102975
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4743 This function clears an image cache, removing all the images stored in
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4744 it. If @var{filter} is omitted or @code{nil}, it clears the cache for
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4745 the selected frame. If @var{filter} is a frame, it clears the cache
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4746 for that frame. If @var{filter} is @code{t}, all image caches are
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4747 cleared. Otherwise, @var{filter} is taken to be a file name, and all
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4748 images associated with that file name are removed from all image
efeb215b8665 * display.texi (Truncation): Overlays can use line-prefix and
Chong Yidong <cyd@stupidchicken.com>
parents: 102950
diff changeset
4749 caches.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4750 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4751
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4752 If an image in the image cache has not been displayed for a specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4753 period of time, Emacs removes it from the cache and frees the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4754 associated memory.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4755
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4756 @defvar image-cache-eviction-delay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4757 This variable specifies the number of seconds an image can remain in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4758 cache without being displayed. When an image is not displayed for this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4759 length of time, Emacs removes it from the image cache.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4760
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4761 If the value is @code{nil}, Emacs does not remove images from the cache
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4762 except when you explicitly clear it. This mode can be useful for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4763 debugging.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4764 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4765
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4766 @node Buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4767 @section Buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4768 @cindex buttons in buffers
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4769 @cindex clickable buttons in buffers
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4770
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4771 The @emph{button} package defines functions for inserting and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4772 manipulating clickable (with the mouse, or via keyboard commands)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4773 buttons in Emacs buffers, such as might be used for help hyper-links,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4774 etc. Emacs uses buttons for the hyper-links in help text and the like.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4775
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4776 A button is essentially a set of properties attached (via text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4777 properties or overlays) to a region of text in an Emacs buffer. These
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4778 properties are called @dfn{button properties}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4779
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4780 One of these properties (@code{action}) is a function, which will
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4781 be called when the user invokes it using the keyboard or the mouse.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4782 The invoked function may then examine the button and use its other
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4783 properties as desired.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4784
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4785 In some ways the Emacs button package duplicates functionality offered
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4786 by the widget package (@pxref{Top, , Introduction, widget, The Emacs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4787 Widget Library}), but the button package has the advantage that it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4788 much faster, much smaller, and much simpler to use (for elisp
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4789 programmers---for users, the result is about the same). The extra
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4790 speed and space savings are useful mainly if you need to create many
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4791 buttons in a buffer (for instance an @code{*Apropos*} buffer uses
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4792 buttons to make entries clickable, and may contain many thousands of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4793 entries).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4794
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4795 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4796 * Button Properties:: Button properties with special meanings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4797 * Button Types:: Defining common properties for classes of buttons.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4798 * Making Buttons:: Adding buttons to Emacs buffers.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4799 * Manipulating Buttons:: Getting and setting properties of buttons.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4800 * Button Buffer Commands:: Buffer-wide commands and bindings for buttons.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4801 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4802
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4803 @node Button Properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4804 @subsection Button Properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4805 @cindex button properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4806
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4807 Buttons have an associated list of properties defining their
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4808 appearance and behavior, and other arbitrary properties may be used
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4809 for application specific purposes. Some properties that have special
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4810 meaning to the button package include:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4811
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4812 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4813 @item action
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4814 @kindex action @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4815 The function to call when the user invokes the button, which is passed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4816 the single argument @var{button}. By default this is @code{ignore},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4817 which does nothing.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4818
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4819 @item mouse-action
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4820 @kindex mouse-action @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4821 This is similar to @code{action}, and when present, will be used
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4822 instead of @code{action} for button invocations resulting from
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4823 mouse-clicks (instead of the user hitting @key{RET}). If not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4824 present, mouse-clicks use @code{action} instead.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4825
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4826 @item face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4827 @kindex face @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4828 This is an Emacs face controlling how buttons of this type are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4829 displayed; by default this is the @code{button} face.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4830
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4831 @item mouse-face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4832 @kindex mouse-face @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4833 This is an additional face which controls appearance during
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4834 mouse-overs (merged with the usual button face); by default this is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4835 the usual Emacs @code{highlight} face.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4836
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4837 @item keymap
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4838 @kindex keymap @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4839 The button's keymap, defining bindings active within the button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4840 region. By default this is the usual button region keymap, stored
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4841 in the variable @code{button-map}, which defines @key{RET} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4842 @key{mouse-2} to invoke the button.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4843
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4844 @item type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4845 @kindex type @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4846 The button-type of the button. When creating a button, this is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4847 usually specified using the @code{:type} keyword argument.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4848 @xref{Button Types}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4849
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4850 @item help-echo
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4851 @kindex help-index @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4852 A string displayed by the Emacs tool-tip help system; by default,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4853 @code{"mouse-2, RET: Push this button"}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4854
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4855 @item follow-link
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4856 @kindex follow-link @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4857 The follow-link property, defining how a @key{Mouse-1} click behaves
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 102515
diff changeset
4858 on this button, @xref{Clickable Text}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4859
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4860 @item button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4861 @kindex button @r{(button property)}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4862 All buttons have a non-@code{nil} @code{button} property, which may be useful
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4863 in finding regions of text that comprise buttons (which is what the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4864 standard button functions do).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4865 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4866
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4867 There are other properties defined for the regions of text in a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4868 button, but these are not generally interesting for typical uses.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4869
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4870 @node Button Types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4871 @subsection Button Types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4872 @cindex button types
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4873
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4874 Every button has a button @emph{type}, which defines default values
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4875 for the button's properties. Button types are arranged in a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4876 hierarchy, with specialized types inheriting from more general types,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4877 so that it's easy to define special-purpose types of buttons for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4878 specific tasks.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4879
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4880 @defun define-button-type name &rest properties
88019
36cc1038d878 (Button Types): For define-button-type, clarify type of NAME.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 87649
diff changeset
4881 Define a `button type' called @var{name} (a symbol).
36cc1038d878 (Button Types): For define-button-type, clarify type of NAME.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 87649
diff changeset
4882 The remaining arguments
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4883 form a sequence of @var{property value} pairs, specifying default
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4884 property values for buttons with this type (a button's type may be set
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4885 by giving it a @code{type} property when creating the button, using
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4886 the @code{:type} keyword argument).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4887
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4888 In addition, the keyword argument @code{:supertype} may be used to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4889 specify a button-type from which @var{name} inherits its default
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4890 property values. Note that this inheritance happens only when
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4891 @var{name} is defined; subsequent changes to a supertype are not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4892 reflected in its subtypes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4893 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4894
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4895 Using @code{define-button-type} to define default properties for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4896 buttons is not necessary---buttons without any specified type use the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4897 built-in button-type @code{button}---but it is encouraged, since
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4898 doing so usually makes the resulting code clearer and more efficient.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4899
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4900 @node Making Buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4901 @subsection Making Buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4902 @cindex making buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4903
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4904 Buttons are associated with a region of text, using an overlay or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4905 text properties to hold button-specific information, all of which are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4906 initialized from the button's type (which defaults to the built-in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4907 button type @code{button}). Like all Emacs text, the appearance of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4908 the button is governed by the @code{face} property; by default (via
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4909 the @code{face} property inherited from the @code{button} button-type)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4910 this is a simple underline, like a typical web-page link.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4911
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4912 For convenience, there are two sorts of button-creation functions,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4913 those that add button properties to an existing region of a buffer,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4914 called @code{make-...button}, and those that also insert the button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4915 text, called @code{insert-...button}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4916
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4917 The button-creation functions all take the @code{&rest} argument
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4918 @var{properties}, which should be a sequence of @var{property value}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4919 pairs, specifying properties to add to the button; see @ref{Button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4920 Properties}. In addition, the keyword argument @code{:type} may be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4921 used to specify a button-type from which to inherit other properties;
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4922 see @ref{Button Types}. Any properties not explicitly specified
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4923 during creation will be inherited from the button's type (if the type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4924 defines such a property).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4925
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4926 The following functions add a button using an overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4927 (@pxref{Overlays}) to hold the button properties:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4928
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4929 @defun make-button beg end &rest properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4930 This makes a button from @var{beg} to @var{end} in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4931 current buffer, and returns it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4932 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4933
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4934 @defun insert-button label &rest properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4935 This insert a button with the label @var{label} at point,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4936 and returns it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4937 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4938
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4939 The following functions are similar, but use Emacs text properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4940 (@pxref{Text Properties}) to hold the button properties, making the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4941 button actually part of the text instead of being a property of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4942 buffer. Buttons using text properties do not create markers into the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4943 buffer, which is important for speed when you use extremely large
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4944 numbers of buttons. Both functions return the position of the start
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4945 of the new button:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4946
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4947 @defun make-text-button beg end &rest properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4948 This makes a button from @var{beg} to @var{end} in the current buffer, using
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4949 text properties.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4950 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4951
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4952 @defun insert-text-button label &rest properties
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4953 This inserts a button with the label @var{label} at point, using text
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4954 properties.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4955 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4956
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4957 @node Manipulating Buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4958 @subsection Manipulating Buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4959 @cindex manipulating buttons
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4960
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4961 These are functions for getting and setting properties of buttons.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4962 Often these are used by a button's invocation function to determine
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4963 what to do.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4964
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4965 Where a @var{button} parameter is specified, it means an object
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4966 referring to a specific button, either an overlay (for overlay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4967 buttons), or a buffer-position or marker (for text property buttons).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4968 Such an object is passed as the first argument to a button's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4969 invocation function when it is invoked.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4970
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4971 @defun button-start button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4972 Return the position at which @var{button} starts.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4973 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4974
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4975 @defun button-end button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4976 Return the position at which @var{button} ends.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4977 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4978
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4979 @defun button-get button prop
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4980 Get the property of button @var{button} named @var{prop}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4981 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4982
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4983 @defun button-put button prop val
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4984 Set @var{button}'s @var{prop} property to @var{val}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4985 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4986
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4987 @defun button-activate button &optional use-mouse-action
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4988 Call @var{button}'s @code{action} property (i.e., invoke it). If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4989 @var{use-mouse-action} is non-@code{nil}, try to invoke the button's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4990 @code{mouse-action} property instead of @code{action}; if the button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4991 has no @code{mouse-action} property, use @code{action} as normal.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4992 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4993
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4994 @defun button-label button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4995 Return @var{button}'s text label.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4996 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4997
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4998 @defun button-type button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4999 Return @var{button}'s button-type.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5000 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5001
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5002 @defun button-has-type-p button type
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5003 Return @code{t} if @var{button} has button-type @var{type}, or one of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5004 @var{type}'s subtypes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5005 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5006
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5007 @defun button-at pos
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5008 Return the button at position @var{pos} in the current buffer, or @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5009 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5010
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5011 @defun button-type-put type prop val
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5012 Set the button-type @var{type}'s @var{prop} property to @var{val}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5013 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5014
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5015 @defun button-type-get type prop
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5016 Get the property of button-type @var{type} named @var{prop}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5017 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5018
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5019 @defun button-type-subtype-p type supertype
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5020 Return @code{t} if button-type @var{type} is a subtype of @var{supertype}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5021 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5022
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5023 @node Button Buffer Commands
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5024 @subsection Button Buffer Commands
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5025 @cindex button buffer commands
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5026
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5027 These are commands and functions for locating and operating on
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5028 buttons in an Emacs buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5029
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5030 @code{push-button} is the command that a user uses to actually `push'
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5031 a button, and is bound by default in the button itself to @key{RET}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5032 and to @key{mouse-2} using a region-specific keymap. Commands
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5033 that are useful outside the buttons itself, such as
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5034 @code{forward-button} and @code{backward-button} are additionally
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5035 available in the keymap stored in @code{button-buffer-map}; a mode
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5036 which uses buttons may want to use @code{button-buffer-map} as a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5037 parent keymap for its keymap.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5038
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5039 If the button has a non-@code{nil} @code{follow-link} property, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5040 @var{mouse-1-click-follows-link} is set, a quick @key{Mouse-1} click
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5041 will also activate the @code{push-button} command.
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 102515
diff changeset
5042 @xref{Clickable Text}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5043
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5044 @deffn Command push-button &optional pos use-mouse-action
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5045 Perform the action specified by a button at location @var{pos}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5046 @var{pos} may be either a buffer position or a mouse-event. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5047 @var{use-mouse-action} is non-@code{nil}, or @var{pos} is a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5048 mouse-event (@pxref{Mouse Events}), try to invoke the button's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5049 @code{mouse-action} property instead of @code{action}; if the button
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5050 has no @code{mouse-action} property, use @code{action} as normal.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5051 @var{pos} defaults to point, except when @code{push-button} is invoked
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5052 interactively as the result of a mouse-event, in which case, the mouse
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5053 event's position is used. If there's no button at @var{pos}, do
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5054 nothing and return @code{nil}, otherwise return @code{t}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5055 @end deffn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5056
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5057 @deffn Command forward-button n &optional wrap display-message
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5058 Move to the @var{n}th next button, or @var{n}th previous button if
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5059 @var{n} is negative. If @var{n} is zero, move to the start of any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5060 button at point. If @var{wrap} is non-@code{nil}, moving past either
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5061 end of the buffer continues from the other end. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5062 @var{display-message} is non-@code{nil}, the button's help-echo string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5063 is displayed. Any button with a non-@code{nil} @code{skip} property
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5064 is skipped over. Returns the button found.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5065 @end deffn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5066
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5067 @deffn Command backward-button n &optional wrap display-message
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5068 Move to the @var{n}th previous button, or @var{n}th next button if
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5069 @var{n} is negative. If @var{n} is zero, move to the start of any
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5070 button at point. If @var{wrap} is non-@code{nil}, moving past either
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5071 end of the buffer continues from the other end. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5072 @var{display-message} is non-@code{nil}, the button's help-echo string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5073 is displayed. Any button with a non-@code{nil} @code{skip} property
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5074 is skipped over. Returns the button found.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5075 @end deffn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5076
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5077 @defun next-button pos &optional count-current
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5078 @defunx previous-button pos &optional count-current
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5079 Return the next button after (for @code{next-button} or before (for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5080 @code{previous-button}) position @var{pos} in the current buffer. If
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5081 @var{count-current} is non-@code{nil}, count any button at @var{pos}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5082 in the search, instead of starting at the next button.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5083 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5084
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5085 @node Abstract Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5086 @section Abstract Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5087 @cindex ewoc
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5088 @cindex display, abstract
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5089 @cindex display, arbitrary objects
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5090 @cindex model/view/controller
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5091 @cindex view part, model/view/controller
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5092
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5093 The Ewoc package constructs buffer text that represents a structure
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5094 of Lisp objects, and updates the text to follow changes in that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5095 structure. This is like the ``view'' component in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5096 ``model/view/controller'' design paradigm.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5097
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5098 An @dfn{ewoc} is a structure that organizes information required to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5099 construct buffer text that represents certain Lisp data. The buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5100 text of the ewoc has three parts, in order: first, fixed @dfn{header}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5101 text; next, textual descriptions of a series of data elements (Lisp
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5102 objects that you specify); and last, fixed @dfn{footer} text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5103 Specifically, an ewoc contains information on:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5104
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5105 @itemize @bullet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5106 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5107 The buffer which its text is generated in.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5108
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5109 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5110 The text's start position in the buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5111
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5112 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5113 The header and footer strings.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5114
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5115 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5116 A doubly-linked chain of @dfn{nodes}, each of which contains:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5117
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5118 @itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5119 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5120 A @dfn{data element}, a single Lisp object.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5121
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5122 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5123 Links to the preceding and following nodes in the chain.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5124 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5125
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5126 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5127 A @dfn{pretty-printer} function which is responsible for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5128 inserting the textual representation of a data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5129 element value into the current buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5130 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5131
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5132 Typically, you define an ewoc with @code{ewoc-create}, and then pass
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5133 the resulting ewoc structure to other functions in the Ewoc package to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5134 build nodes within it, and display it in the buffer. Once it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5135 displayed in the buffer, other functions determine the correspondance
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5136 between buffer positions and nodes, move point from one node's textual
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5137 representation to another, and so forth. @xref{Abstract Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5138 Functions}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5139
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5140 A node @dfn{encapsulates} a data element much the way a variable
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5141 holds a value. Normally, encapsulation occurs as a part of adding a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5142 node to the ewoc. You can retrieve the data element value and place a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5143 new value in its place, like so:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5144
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5145 @lisp
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5146 (ewoc-data @var{node})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5147 @result{} value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5148
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5149 (ewoc-set-data @var{node} @var{new-value})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5150 @result{} @var{new-value}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5151 @end lisp
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5152
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5153 @noindent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5154 You can also use, as the data element value, a Lisp object (list or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5155 vector) that is a container for the ``real'' value, or an index into
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5156 some other structure. The example (@pxref{Abstract Display Example})
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5157 uses the latter approach.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5158
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5159 When the data changes, you will want to update the text in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5160 buffer. You can update all nodes by calling @code{ewoc-refresh}, or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5161 just specific nodes using @code{ewoc-invalidate}, or all nodes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5162 satisfying a predicate using @code{ewoc-map}. Alternatively, you can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5163 delete invalid nodes using @code{ewoc-delete} or @code{ewoc-filter},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5164 and add new nodes in their place. Deleting a node from an ewoc deletes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5165 its associated textual description from buffer, as well.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5166
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5167 @menu
103820
9e06f7e38c79 (Abstract Display): Merge in some menu descriptions from elisp.texi.
Glenn Morris <rgm@gnu.org>
parents: 103586
diff changeset
5168 * Abstract Display Functions:: Functions in the Ewoc package.
9e06f7e38c79 (Abstract Display): Merge in some menu descriptions from elisp.texi.
Glenn Morris <rgm@gnu.org>
parents: 103586
diff changeset
5169 * Abstract Display Example:: Example of using Ewoc.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5170 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5171
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5172 @node Abstract Display Functions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5173 @subsection Abstract Display Functions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5174
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5175 In this subsection, @var{ewoc} and @var{node} stand for the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5176 structures described above (@pxref{Abstract Display}), while
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5177 @var{data} stands for an arbitrary Lisp object used as a data element.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5178
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5179 @defun ewoc-create pretty-printer &optional header footer nosep
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5180 This constructs and returns a new ewoc, with no nodes (and thus no data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5181 elements). @var{pretty-printer} should be a function that takes one
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5182 argument, a data element of the sort you plan to use in this ewoc, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5183 inserts its textual description at point using @code{insert} (and never
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5184 @code{insert-before-markers}, because that would interfere with the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5185 Ewoc package's internal mechanisms).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5186
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5187 Normally, a newline is automatically inserted after the header,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5188 the footer and every node's textual description. If @var{nosep}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5189 is non-@code{nil}, no newline is inserted. This may be useful for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5190 displaying an entire ewoc on a single line, for example, or for
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5191 making nodes ``invisible'' by arranging for @var{pretty-printer}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5192 to do nothing for those nodes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5193
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5194 An ewoc maintains its text in the buffer that is current when
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5195 you create it, so switch to the intended buffer before calling
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5196 @code{ewoc-create}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5197 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5198
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5199 @defun ewoc-buffer ewoc
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5200 This returns the buffer where @var{ewoc} maintains its text.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5201 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5202
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5203 @defun ewoc-get-hf ewoc
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5204 This returns a cons cell @code{(@var{header} . @var{footer})}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5205 made from @var{ewoc}'s header and footer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5206 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5207
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5208 @defun ewoc-set-hf ewoc header footer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5209 This sets the header and footer of @var{ewoc} to the strings
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5210 @var{header} and @var{footer}, respectively.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5211 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5212
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5213 @defun ewoc-enter-first ewoc data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5214 @defunx ewoc-enter-last ewoc data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5215 These add a new node encapsulating @var{data}, putting it, respectively,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5216 at the beginning or end of @var{ewoc}'s chain of nodes.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5217 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5218
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5219 @defun ewoc-enter-before ewoc node data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5220 @defunx ewoc-enter-after ewoc node data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5221 These add a new node encapsulating @var{data}, adding it to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5222 @var{ewoc} before or after @var{node}, respectively.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5223 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5224
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5225 @defun ewoc-prev ewoc node
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5226 @defunx ewoc-next ewoc node
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5227 These return, respectively, the previous node and the next node of @var{node}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5228 in @var{ewoc}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5229 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5230
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5231 @defun ewoc-nth ewoc n
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5232 This returns the node in @var{ewoc} found at zero-based index @var{n}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5233 A negative @var{n} means count from the end. @code{ewoc-nth} returns
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5234 @code{nil} if @var{n} is out of range.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5235 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5236
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5237 @defun ewoc-data node
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5238 This extracts the data encapsulated by @var{node} and returns it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5239 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5240
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5241 @defun ewoc-set-data node data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5242 This sets the data encapsulated by @var{node} to @var{data}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5243 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5244
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5245 @defun ewoc-locate ewoc &optional pos guess
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5246 This determines the node in @var{ewoc} which contains point (or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5247 @var{pos} if specified), and returns that node. If @var{ewoc} has no
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5248 nodes, it returns @code{nil}. If @var{pos} is before the first node,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5249 it returns the first node; if @var{pos} is after the last node, it returns
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5250 the last node. The optional third arg @var{guess}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5251 should be a node that is likely to be near @var{pos}; this doesn't
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5252 alter the result, but makes the function run faster.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5253 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5254
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5255 @defun ewoc-location node
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5256 This returns the start position of @var{node}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5257 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5258
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5259 @defun ewoc-goto-prev ewoc arg
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5260 @defunx ewoc-goto-next ewoc arg
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5261 These move point to the previous or next, respectively, @var{arg}th node
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5262 in @var{ewoc}. @code{ewoc-goto-prev} does not move if it is already at
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5263 the first node or if @var{ewoc} is empty, whereas @code{ewoc-goto-next}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5264 moves past the last node, returning @code{nil}. Excepting this special
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5265 case, these functions return the node moved to.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5266 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5267
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5268 @defun ewoc-goto-node ewoc node
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5269 This moves point to the start of @var{node} in @var{ewoc}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5270 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5271
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5272 @defun ewoc-refresh ewoc
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5273 This function regenerates the text of @var{ewoc}. It works by
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5274 deleting the text between the header and the footer, i.e., all the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5275 data elements' representations, and then calling the pretty-printer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5276 function for each node, one by one, in order.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5277 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5278
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5279 @defun ewoc-invalidate ewoc &rest nodes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5280 This is similar to @code{ewoc-refresh}, except that only @var{nodes} in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5281 @var{ewoc} are updated instead of the entire set.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5282 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5283
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5284 @defun ewoc-delete ewoc &rest nodes
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5285 This deletes each node in @var{nodes} from @var{ewoc}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5286 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5287
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5288 @defun ewoc-filter ewoc predicate &rest args
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5289 This calls @var{predicate} for each data element in @var{ewoc} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5290 deletes those nodes for which @var{predicate} returns @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5291 Any @var{args} are passed to @var{predicate}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5292 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5293
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5294 @defun ewoc-collect ewoc predicate &rest args
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5295 This calls @var{predicate} for each data element in @var{ewoc}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5296 and returns a list of those elements for which @var{predicate}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5297 returns non-@code{nil}. The elements in the list are ordered
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5298 as in the buffer. Any @var{args} are passed to @var{predicate}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5299 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5300
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5301 @defun ewoc-map map-function ewoc &rest args
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5302 This calls @var{map-function} for each data element in @var{ewoc} and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5303 updates those nodes for which @var{map-function} returns non-@code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5304 Any @var{args} are passed to @var{map-function}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5305 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5306
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5307 @node Abstract Display Example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5308 @subsection Abstract Display Example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5309
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5310 Here is a simple example using functions of the ewoc package to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5311 implement a ``color components display,'' an area in a buffer that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5312 represents a vector of three integers (itself representing a 24-bit RGB
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5313 value) in various ways.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5314
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5315 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5316 (setq colorcomp-ewoc nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5317 colorcomp-data nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5318 colorcomp-mode-map nil
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5319 colorcomp-labels ["Red" "Green" "Blue"])
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5320
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5321 (defun colorcomp-pp (data)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5322 (if data
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5323 (let ((comp (aref colorcomp-data data)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5324 (insert (aref colorcomp-labels data) "\t: #x"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5325 (format "%02X" comp) " "
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5326 (make-string (ash comp -2) ?#) "\n"))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5327 (let ((cstr (format "#%02X%02X%02X"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5328 (aref colorcomp-data 0)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5329 (aref colorcomp-data 1)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5330 (aref colorcomp-data 2)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5331 (samp " (sample text) "))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5332 (insert "Color\t: "
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5333 (propertize samp 'face `(foreground-color . ,cstr))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5334 (propertize samp 'face `(background-color . ,cstr))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5335 "\n"))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5336
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5337 (defun colorcomp (color)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5338 "Allow fiddling with COLOR in a new buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5339 The buffer is in Color Components mode."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5340 (interactive "sColor (name or #RGB or #RRGGBB): ")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5341 (when (string= "" color)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5342 (setq color "green"))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5343 (unless (color-values color)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5344 (error "No such color: %S" color))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5345 (switch-to-buffer
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5346 (generate-new-buffer (format "originally: %s" color)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5347 (kill-all-local-variables)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5348 (setq major-mode 'colorcomp-mode
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5349 mode-name "Color Components")
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5350 (use-local-map colorcomp-mode-map)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5351 (erase-buffer)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5352 (buffer-disable-undo)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5353 (let ((data (apply 'vector (mapcar (lambda (n) (ash n -8))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5354 (color-values color))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5355 (ewoc (ewoc-create 'colorcomp-pp
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5356 "\nColor Components\n\n"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5357 (substitute-command-keys
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5358 "\n\\@{colorcomp-mode-map@}"))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5359 (set (make-local-variable 'colorcomp-data) data)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5360 (set (make-local-variable 'colorcomp-ewoc) ewoc)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5361 (ewoc-enter-last ewoc 0)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5362 (ewoc-enter-last ewoc 1)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5363 (ewoc-enter-last ewoc 2)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5364 (ewoc-enter-last ewoc nil)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5365 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5366
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5367 @cindex controller part, model/view/controller
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5368 This example can be extended to be a ``color selection widget'' (in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5369 other words, the controller part of the ``model/view/controller''
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5370 design paradigm) by defining commands to modify @code{colorcomp-data}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5371 and to ``finish'' the selection process, and a keymap to tie it all
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5372 together conveniently.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5373
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5374 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5375 (defun colorcomp-mod (index limit delta)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5376 (let ((cur (aref colorcomp-data index)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5377 (unless (= limit cur)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5378 (aset colorcomp-data index (+ cur delta)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5379 (ewoc-invalidate
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5380 colorcomp-ewoc
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5381 (ewoc-nth colorcomp-ewoc index)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5382 (ewoc-nth colorcomp-ewoc -1))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5383
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5384 (defun colorcomp-R-more () (interactive) (colorcomp-mod 0 255 1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5385 (defun colorcomp-G-more () (interactive) (colorcomp-mod 1 255 1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5386 (defun colorcomp-B-more () (interactive) (colorcomp-mod 2 255 1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5387 (defun colorcomp-R-less () (interactive) (colorcomp-mod 0 0 -1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5388 (defun colorcomp-G-less () (interactive) (colorcomp-mod 1 0 -1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5389 (defun colorcomp-B-less () (interactive) (colorcomp-mod 2 0 -1))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5390
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5391 (defun colorcomp-copy-as-kill-and-exit ()
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5392 "Copy the color components into the kill ring and kill the buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5393 The string is formatted #RRGGBB (hash followed by six hex digits)."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5394 (interactive)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5395 (kill-new (format "#%02X%02X%02X"
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5396 (aref colorcomp-data 0)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5397 (aref colorcomp-data 1)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5398 (aref colorcomp-data 2)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5399 (kill-buffer nil))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5400
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5401 (setq colorcomp-mode-map
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5402 (let ((m (make-sparse-keymap)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5403 (suppress-keymap m)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5404 (define-key m "i" 'colorcomp-R-less)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5405 (define-key m "o" 'colorcomp-R-more)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5406 (define-key m "k" 'colorcomp-G-less)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5407 (define-key m "l" 'colorcomp-G-more)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5408 (define-key m "," 'colorcomp-B-less)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5409 (define-key m "." 'colorcomp-B-more)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5410 (define-key m " " 'colorcomp-copy-as-kill-and-exit)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5411 m))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5412 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5413
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5414 Note that we never modify the data in each node, which is fixed when the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5415 ewoc is created to be either @code{nil} or an index into the vector
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5416 @code{colorcomp-data}, the actual color components.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5417
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5418 @node Blinking
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5419 @section Blinking Parentheses
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5420 @cindex parenthesis matching
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5421 @cindex blinking parentheses
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5422 @cindex balancing parentheses
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5423
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5424 This section describes the mechanism by which Emacs shows a matching
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5425 open parenthesis when the user inserts a close parenthesis.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5426
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5427 @defvar blink-paren-function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5428 The value of this variable should be a function (of no arguments) to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5429 be called whenever a character with close parenthesis syntax is inserted.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5430 The value of @code{blink-paren-function} may be @code{nil}, in which
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5431 case nothing is done.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5432 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5433
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5434 @defopt blink-matching-paren
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5435 If this variable is @code{nil}, then @code{blink-matching-open} does
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5436 nothing.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5437 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5438
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5439 @defopt blink-matching-paren-distance
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5440 This variable specifies the maximum distance to scan for a matching
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5441 parenthesis before giving up.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5442 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5443
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5444 @defopt blink-matching-delay
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5445 This variable specifies the number of seconds for the cursor to remain
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5446 at the matching parenthesis. A fraction of a second often gives
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5447 good results, but the default is 1, which works on all systems.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5448 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5449
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5450 @deffn Command blink-matching-open
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5451 This function is the default value of @code{blink-paren-function}. It
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5452 assumes that point follows a character with close parenthesis syntax and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5453 moves the cursor momentarily to the matching opening character. If that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5454 character is not already on the screen, it displays the character's
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5455 context in the echo area. To avoid long delays, this function does not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5456 search farther than @code{blink-matching-paren-distance} characters.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5457
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5458 Here is an example of calling this function explicitly.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5459
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5460 @smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5461 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5462 (defun interactive-blink-matching-open ()
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5463 @c Do not break this line! -- rms.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5464 @c The first line of a doc string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5465 @c must stand alone.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5466 "Indicate momentarily the start of sexp before point."
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5467 (interactive)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5468 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5469 @group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5470 (let ((blink-matching-paren-distance
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5471 (buffer-size))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5472 (blink-matching-paren t))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5473 (blink-matching-open)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5474 @end group
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5475 @end smallexample
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5476 @end deffn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5477
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5478 @node Usual Display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5479 @section Usual Display Conventions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5480
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5481 The usual display conventions define how to display each character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5482 code. You can override these conventions by setting up a display table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5483 (@pxref{Display Tables}). Here are the usual display conventions:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5484
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5485 @itemize @bullet
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5486 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5487 Character codes 32 through 126 map to glyph codes 32 through 126.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5488 Normally this means they display as themselves.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5489
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5490 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5491 Character code 9 is a horizontal tab. It displays as whitespace
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5492 up to a position determined by @code{tab-width}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5493
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5494 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5495 Character code 10 is a newline.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5496
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5497 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5498 All other codes in the range 0 through 31, and code 127, display in one
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5499 of two ways according to the value of @code{ctl-arrow}. If it is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5500 non-@code{nil}, these codes map to sequences of two glyphs, where the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5501 first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5502 specify a glyph to use instead of @samp{^}.) Otherwise, these codes map
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5503 just like the codes in the range 128 to 255.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5504
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5505 On MS-DOS terminals, Emacs arranges by default for the character code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5506 127 to be mapped to the glyph code 127, which normally displays as an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5507 empty polygon. This glyph is used to display non-@acronym{ASCII} characters
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5508 that the MS-DOS terminal doesn't support. @xref{MS-DOS and MULE,,,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5509 emacs, The GNU Emacs Manual}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5510
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5511 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5512 Character codes 128 through 255 map to sequences of four glyphs, where
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5513 the first glyph is the @acronym{ASCII} code for @samp{\}, and the others are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5514 digit characters representing the character code in octal. (A display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5515 table can specify a glyph to use instead of @samp{\}.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5516
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5517 @item
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5518 Multibyte character codes above 256 are displayed as themselves, or as a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5519 question mark or empty box if the terminal cannot display that
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5520 character.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5521 @end itemize
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5522
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5523 The usual display conventions apply even when there is a display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5524 table, for any character whose entry in the active display table is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5525 @code{nil}. Thus, when you set up a display table, you need only
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5526 specify the characters for which you want special behavior.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5527
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5528 These display rules apply to carriage return (character code 13), when
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5529 it appears in the buffer. But that character may not appear in the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5530 buffer where you expect it, if it was eliminated as part of end-of-line
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5531 conversion (@pxref{Coding System Basics}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5532
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5533 These variables affect the way certain characters are displayed on the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5534 screen. Since they change the number of columns the characters occupy,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5535 they also affect the indentation functions. These variables also affect
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5536 how the mode line is displayed; if you want to force redisplay of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5537 mode line using the new values, call the function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5538 @code{force-mode-line-update} (@pxref{Mode Line Format}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5539
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5540 @defopt ctl-arrow
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5541 @cindex control characters in display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5542 This buffer-local variable controls how control characters are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5543 displayed. If it is non-@code{nil}, they are displayed as a caret
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5544 followed by the character: @samp{^A}. If it is @code{nil}, they are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5545 displayed as a backslash followed by three octal digits: @samp{\001}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5546 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5547
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5548 @c Following may have overfull hbox.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5549 @defvar default-ctl-arrow
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5550 The value of this variable is the default value for @code{ctl-arrow} in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5551 buffers that do not override it. @xref{Default Value}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5552 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5553
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5554 @defopt tab-width
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5555 The value of this buffer-local variable is the spacing between tab
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5556 stops used for displaying tab characters in Emacs buffers. The value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5557 is in units of columns, and the default is 8. Note that this feature
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5558 is completely independent of the user-settable tab stops used by the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5559 command @code{tab-to-tab-stop}. @xref{Indent Tabs}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5560 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5561
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5562 @node Display Tables
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5563 @section Display Tables
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5564
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5565 @cindex display table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5566 You can use the @dfn{display table} feature to control how all possible
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5567 character codes display on the screen. This is useful for displaying
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5568 European languages that have letters not in the @acronym{ASCII} character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5569 set.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5570
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5571 The display table maps each character code into a sequence of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5572 @dfn{glyphs}, each glyph being a graphic that takes up one character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5573 position on the screen. You can also define how to display each glyph
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5574 on your terminal, using the @dfn{glyph table}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5575
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5576 Display tables affect how the mode line is displayed; if you want to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5577 force redisplay of the mode line using a new display table, call
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5578 @code{force-mode-line-update} (@pxref{Mode Line Format}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5579
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5580 @menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5581 * Display Table Format:: What a display table consists of.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5582 * Active Display Table:: How Emacs selects a display table to use.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5583 * Glyphs:: How to define a glyph, and what glyphs mean.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5584 @end menu
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5585
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5586 @node Display Table Format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5587 @subsection Display Table Format
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5588
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5589 A display table is actually a char-table (@pxref{Char-Tables}) with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5590 @code{display-table} as its subtype.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5591
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5592 @defun make-display-table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5593 This creates and returns a display table. The table initially has
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5594 @code{nil} in all elements.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5595 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5596
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5597 The ordinary elements of the display table are indexed by character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5598 codes; the element at index @var{c} says how to display the character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5599 code @var{c}. The value should be @code{nil} or a vector of the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5600 glyphs to be output (@pxref{Glyphs}). @code{nil} says to display the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5601 character @var{c} according to the usual display conventions
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5602 (@pxref{Usual Display}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5603
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5604 @strong{Warning:} if you use the display table to change the display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5605 of newline characters, the whole buffer will be displayed as one long
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5606 ``line.''
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5607
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5608 The display table also has six ``extra slots'' which serve special
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5609 purposes. Here is a table of their meanings; @code{nil} in any slot
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5610 means to use the default for that slot, as stated below.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5611
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5612 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5613 @item 0
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5614 The glyph for the end of a truncated screen line (the default for this
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5615 is @samp{$}). @xref{Glyphs}. On graphical terminals, Emacs uses
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5616 arrows in the fringes to indicate truncation, so the display table has
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5617 no effect.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5618
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5619 @item 1
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5620 The glyph for the end of a continued line (the default is @samp{\}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5621 On graphical terminals, Emacs uses curved arrows in the fringes to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5622 indicate continuation, so the display table has no effect.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5623
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5624 @item 2
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5625 The glyph for indicating a character displayed as an octal character
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5626 code (the default is @samp{\}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5627
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5628 @item 3
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5629 The glyph for indicating a control character (the default is @samp{^}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5630
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5631 @item 4
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5632 A vector of glyphs for indicating the presence of invisible lines (the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5633 default is @samp{...}). @xref{Selective Display}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5634
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5635 @item 5
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5636 The glyph used to draw the border between side-by-side windows (the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5637 default is @samp{|}). @xref{Splitting Windows}. This takes effect only
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5638 when there are no scroll bars; if scroll bars are supported and in use,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5639 a scroll bar separates the two windows.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5640 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5641
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5642 For example, here is how to construct a display table that mimics the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5643 effect of setting @code{ctl-arrow} to a non-@code{nil} value:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5644
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5645 @example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5646 (setq disptab (make-display-table))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5647 (let ((i 0))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5648 (while (< i 32)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5649 (or (= i ?\t) (= i ?\n)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5650 (aset disptab i (vector ?^ (+ i 64))))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5651 (setq i (1+ i)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5652 (aset disptab 127 (vector ?^ ??)))
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5653 @end example
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5654
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5655 @defun display-table-slot display-table slot
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5656 This function returns the value of the extra slot @var{slot} of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5657 @var{display-table}. The argument @var{slot} may be a number from 0 to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5658 5 inclusive, or a slot name (symbol). Valid symbols are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5659 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5660 @code{selective-display}, and @code{vertical-border}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5661 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5662
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5663 @defun set-display-table-slot display-table slot value
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5664 This function stores @var{value} in the extra slot @var{slot} of
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5665 @var{display-table}. The argument @var{slot} may be a number from 0 to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5666 5 inclusive, or a slot name (symbol). Valid symbols are
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5667 @code{truncation}, @code{wrap}, @code{escape}, @code{control},
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5668 @code{selective-display}, and @code{vertical-border}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5669 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5670
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5671 @defun describe-display-table display-table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5672 This function displays a description of the display table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5673 @var{display-table} in a help buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5674 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5675
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5676 @deffn Command describe-current-display-table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5677 This command displays a description of the current display table in a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5678 help buffer.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5679 @end deffn
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5680
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5681 @node Active Display Table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5682 @subsection Active Display Table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5683 @cindex active display table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5684
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5685 Each window can specify a display table, and so can each buffer. When
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5686 a buffer @var{b} is displayed in window @var{w}, display uses the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5687 display table for window @var{w} if it has one; otherwise, the display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5688 table for buffer @var{b} if it has one; otherwise, the standard display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5689 table if any. The display table chosen is called the @dfn{active}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5690 display table.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5691
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5692 @defun window-display-table &optional window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5693 This function returns @var{window}'s display table, or @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5694 if @var{window} does not have an assigned display table. The default
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5695 for @var{window} is the selected window.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5696 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5697
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5698 @defun set-window-display-table window table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5699 This function sets the display table of @var{window} to @var{table}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5700 The argument @var{table} should be either a display table or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5701 @code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5702 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5703
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5704 @defvar buffer-display-table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5705 This variable is automatically buffer-local in all buffers; its value in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5706 a particular buffer specifies the display table for that buffer. If it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5707 is @code{nil}, that means the buffer does not have an assigned display
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5708 table.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5709 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5710
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5711 @defvar standard-display-table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5712 This variable's value is the default display table, used whenever a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5713 window has no display table and neither does the buffer displayed in
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5714 that window. This variable is @code{nil} by default.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5715 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5716
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5717 If there is no display table to use for a particular window---that is,
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5718 if the window specifies none, its buffer specifies none, and
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5719 @code{standard-display-table} is @code{nil}---then Emacs uses the usual
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5720 display conventions for all character codes in that window. @xref{Usual
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5721 Display}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5722
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5723 A number of functions for changing the standard display table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5724 are defined in the library @file{disp-table}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5725
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5726 @node Glyphs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5727 @subsection Glyphs
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5728
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5729 @cindex glyph
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5730 A @dfn{glyph} is a generalization of a character; it stands for an
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5731 image that takes up a single character position on the screen. Normally
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5732 glyphs come from vectors in the display table (@pxref{Display Tables}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5733
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5734 A glyph is represented in Lisp as a @dfn{glyph code}. A glyph code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5735 can be @dfn{simple} or it can be defined by the @dfn{glyph table}. A
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5736 simple glyph code is just a way of specifying a character and a face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5737 to output it in. @xref{Faces}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5738
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5739 The following functions are used to manipulate simple glyph codes:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5740
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5741 @defun make-glyph-code char &optional face
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5742 This function returns a simple glyph code representing char @var{char}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5743 with face @var{face}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5744 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5745
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5746 @defun glyph-char glyph
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5747 This function returns the character of simple glyph code @var{glyph}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5748 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5749
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5750 @defun glyph-face glyph
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5751 This function returns face of simple glyph code @var{glyph}, or
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5752 @code{nil} if @var{glyph} has the default face (face-id 0).
100978
d14fcdc20167 (Attribute Functions): Note that a function value :height is relative,
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
5753 @xref{Face Functions}.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5754 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5755
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5756 On character terminals, you can set up a @dfn{glyph table} to define
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5757 the meaning of glyph codes (represented as small integers).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5758
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5759 @defvar glyph-table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5760 The value of this variable is the current glyph table. It should be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5761 @code{nil} or a vector whose @var{g}th element defines glyph code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5762 @var{g}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5763
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5764 If a glyph code is greater than or equal to the length of the glyph
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5765 table, that code is automatically simple. If @code{glyph-table} is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5766 @code{nil} then all glyph codes are simple.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5767
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5768 The glyph table is used only on character terminals. On graphical
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5769 displays, all glyph codes are simple.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5770 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5771
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5772 Here are the meaningful types of elements in the glyph table:
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5773
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5774 @table @asis
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5775 @item @var{string}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5776 Send the characters in @var{string} to the terminal to output
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5777 this glyph code.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5778
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5779 @item @var{code}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5780 Define this glyph code as an alias for glyph code @var{code} created
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5781 by @code{make-glyph-code}. You can use such an alias to define a
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5782 small-numbered glyph code which specifies a character with a face.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5783
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5784 @item @code{nil}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5785 This glyph code is simple.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5786 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5787
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5788 @defun create-glyph string
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5789 This function returns a newly-allocated glyph code which is set up to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5790 display by sending @var{string} to the terminal.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5791 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5792
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5793 @node Beeping
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5794 @section Beeping
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5795 @c @cindex beeping "beep" is adjacent
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5796 @cindex bell
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5797
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5798 This section describes how to make Emacs ring the bell (or blink the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5799 screen) to attract the user's attention. Be conservative about how
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5800 often you do this; frequent bells can become irritating. Also be
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5801 careful not to use just beeping when signaling an error is more
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5802 appropriate. (@xref{Errors}.)
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5803
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5804 @defun ding &optional do-not-terminate
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5805 @cindex keyboard macro termination
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5806 This function beeps, or flashes the screen (see @code{visible-bell} below).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5807 It also terminates any keyboard macro currently executing unless
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5808 @var{do-not-terminate} is non-@code{nil}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5809 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5810
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5811 @defun beep &optional do-not-terminate
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5812 This is a synonym for @code{ding}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5813 @end defun
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5814
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5815 @defopt visible-bell
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5816 This variable determines whether Emacs should flash the screen to
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5817 represent a bell. Non-@code{nil} means yes, @code{nil} means no. This
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5818 is effective on graphical displays, and on text-only terminals
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5819 provided the terminal's Termcap entry defines the visible bell
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5820 capability (@samp{vb}).
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5821 @end defopt
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5822
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5823 @defvar ring-bell-function
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5824 If this is non-@code{nil}, it specifies how Emacs should ``ring the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5825 bell.'' Its value should be a function of no arguments. If this is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5826 non-@code{nil}, it takes precedence over the @code{visible-bell}
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5827 variable.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5828 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5829
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5830 @node Window Systems
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5831 @section Window Systems
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5832
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5833 Emacs works with several window systems, most notably the X Window
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5834 System. Both Emacs and X use the term ``window,'' but use it
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5835 differently. An Emacs frame is a single window as far as X is
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5836 concerned; the individual Emacs windows are not known to X at all.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5837
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5838 @defvar window-system
100597
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5839 This frame-local variable tells Lisp programs what window system Emacs is using
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5840 for displaying the frame. The possible values are
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5841
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5842 @table @code
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5843 @item x
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5844 @cindex X Window System
100597
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5845 Emacs is displaying the frame using X.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5846 @item w32
100597
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5847 Emacs is displaying the frame using native MS-Windows GUI.
103586
c78f612cb825 * display.texi (Window Systems): Add ns to the list.
Chong Yidong <cyd@stupidchicken.com>
parents: 103273
diff changeset
5848 @item ns
c78f612cb825 * display.texi (Window Systems): Add ns to the list.
Chong Yidong <cyd@stupidchicken.com>
parents: 103273
diff changeset
5849 Emacs is displaying the frame using the Nextstep interface (used on
c78f612cb825 * display.texi (Window Systems): Add ns to the list.
Chong Yidong <cyd@stupidchicken.com>
parents: 103273
diff changeset
5850 GNUstep and Mac OS X).
100597
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5851 @item pc
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5852 Emacs is displaying the frame using MS-DOS direct screen writes.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5853 @item nil
100597
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5854 Emacs is displaying the frame on a character-based terminal.
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5855 @end table
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5856 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5857
100599
d0d51bbf9adf (Window Systems): Document `initial-window-system'.
Eli Zaretskii <eliz@gnu.org>
parents: 100597
diff changeset
5858 @defvar initial-window-system
d0d51bbf9adf (Window Systems): Document `initial-window-system'.
Eli Zaretskii <eliz@gnu.org>
parents: 100597
diff changeset
5859 This variable holds the value of @code{window-system} used for the
101443
5e2cee41c267 (Window Systems): Document the value of `initial-window-system' under --daemon.
Eli Zaretskii <eliz@gnu.org>
parents: 101289
diff changeset
5860 first frame created by Emacs during startup. (When Emacs is invoked
5e2cee41c267 (Window Systems): Document the value of `initial-window-system' under --daemon.
Eli Zaretskii <eliz@gnu.org>
parents: 101289
diff changeset
5861 with the @option{--daemon} option, it does not create any initial
5e2cee41c267 (Window Systems): Document the value of `initial-window-system' under --daemon.
Eli Zaretskii <eliz@gnu.org>
parents: 101289
diff changeset
5862 frames, so @code{initial-window-system} is @code{nil}. @xref{Initial
5e2cee41c267 (Window Systems): Document the value of `initial-window-system' under --daemon.
Eli Zaretskii <eliz@gnu.org>
parents: 101289
diff changeset
5863 Options, daemon,, emacs, The GNU Emacs Manual}.)
100599
d0d51bbf9adf (Window Systems): Document `initial-window-system'.
Eli Zaretskii <eliz@gnu.org>
parents: 100597
diff changeset
5864 @end defvar
d0d51bbf9adf (Window Systems): Document `initial-window-system'.
Eli Zaretskii <eliz@gnu.org>
parents: 100597
diff changeset
5865
100597
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5866 @defun window-system &optional frame
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5867 This function returns a symbol whose name tells what window system is
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5868 used for displaying @var{frame} (which defaults to the currently
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5869 selected frame). The list of possible symbols it returns is the same
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5870 one documented for the variable @code{window-system} above.
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5871 @end defun
849c161c893f (Window Systems): Document `window-system' the function. The variable
Eli Zaretskii <eliz@gnu.org>
parents: 98976
diff changeset
5872
84060
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5873 @defvar window-setup-hook
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5874 This variable is a normal hook which Emacs runs after handling the
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5875 initialization files. Emacs runs this hook after it has completed
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5876 loading your init file, the default initialization file (if
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5877 any), and the terminal-specific Lisp code, and running the hook
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5878 @code{term-setup-hook}.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5879
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5880 This hook is used for internal purposes: setting up communication with
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5881 the window system, and creating the initial window. Users should not
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5882 interfere with it.
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5883 @end defvar
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5884
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5885 @ignore
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5886 arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6
4859027e475d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5887 @end ignore