Mercurial > emacs
annotate lispref/frames.texi @ 27188:8cd1df305566
*** empty log message ***
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Wed, 05 Jan 2000 14:29:52 +0000 |
parents | f6b52258db6a |
children | d2e5f1b7d8e2 |
rev | line source |
---|---|
6547 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6547 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/frames | |
6 @node Frames, Positions, Windows, Top | |
7 @chapter Frames | |
8 @cindex frame | |
9 | |
13155
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
10 A @dfn{frame} is a rectangle on the screen that contains one or more |
6547 | 11 Emacs windows. A frame initially contains a single main window (plus |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
12 perhaps a minibuffer window), which you can subdivide vertically or |
6547 | 13 horizontally into smaller windows. |
14 | |
15 @cindex terminal frame | |
12067 | 16 When Emacs runs on a text-only terminal, it starts with one |
12125
995be67f3fd1
updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
17 @dfn{terminal frame}. If you create additional ones, Emacs displays |
12067 | 18 one and only one at any given time---on the terminal screen, of course. |
19 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
20 @cindex window frame |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
21 When Emacs communicates directly with a supported window system, such |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
22 as X Windows, it does not have a terminal frame; instead, it starts with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
23 a single @dfn{window frame}, but you can create more, and Emacs can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
24 display several such frames at once as is usual for window systems. |
6547 | 25 |
26 @defun framep object | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
27 This predicate returns a non-@code{nil} value if @var{object} is a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
28 frame, and @code{nil} otherwise. For a frame, the value indicates which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
29 kind of display the frame uses: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
30 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
31 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
32 @item x |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
33 The frame is displayed in an X window. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
34 @item t |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
35 A terminal frame on a character display. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
36 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
37 The frame is displayed on a Macintosh. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
38 @item w32 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
39 The frame is displayed on MS-Windows 9X/NT. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
40 @item pc |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
41 The frame is displayed on an MS-DOS terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
42 @end table |
6547 | 43 @end defun |
44 | |
45 @menu | |
12067 | 46 * Creating Frames:: Creating additional frames. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
47 * Multiple Displays:: Creating frames on other displays. |
6547 | 48 * Frame Parameters:: Controlling frame size, position, font, etc. |
12067 | 49 * Frame Titles:: Automatic updating of frame titles. |
6547 | 50 * Deleting Frames:: Frames last until explicitly deleted. |
51 * Finding All Frames:: How to examine all existing frames. | |
52 * Frames and Windows:: A frame contains windows; | |
53 display of text always works through windows. | |
54 * Minibuffers and Frames:: How a frame finds the minibuffer to use. | |
55 * Input Focus:: Specifying the selected frame. | |
56 * Visibility of Frames:: Frames may be visible or invisible, or icons. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
57 * Raising and Lowering:: Raising a frame makes it hide other windows; |
6547 | 58 lowering it makes the others hide them. |
59 * Frame Configurations:: Saving the state of all frames. | |
60 * Mouse Tracking:: Getting events that say when the mouse moves. | |
61 * Mouse Position:: Asking where the mouse is, or moving it. | |
62 * Pop-Up Menus:: Displaying a menu for the user to select from. | |
63 * Dialog Boxes:: Displaying a box to ask yes or no. | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
64 * Pointer Shapes:: Specifying the shape of the mouse pointer. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
65 * Window System Selections:: Transferring text to and from other X clients. |
12098 | 66 * Color Names:: Getting the definitions of color names. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
67 * Text Terminal Colors:: Defining colors for text-only terminals. |
6547 | 68 * Resources:: Getting resource values from the server. |
69 * Server Data:: Getting info about the X server. | |
70 @end menu | |
71 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
72 @xref{Display}, for information about the related topic of |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
73 controlling Emacs redisplay. |
6547 | 74 |
75 @node Creating Frames | |
76 @section Creating Frames | |
77 | |
78 To create a new frame, call the function @code{make-frame}. | |
79 | |
13155
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
80 @defun make-frame &optional alist |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
81 This function creates a new frame. If you are using a supported window |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
82 system, it makes a window frame; otherwise, it makes a terminal frame. |
6547 | 83 |
84 The argument is an alist specifying frame parameters. Any parameters | |
85 not mentioned in @var{alist} default according to the value of the | |
12098 | 86 variable @code{default-frame-alist}; parameters not specified even there |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
87 default from the standard X resources or whatever is used instead on |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
88 your system. |
6547 | 89 |
90 The set of possible parameters depends in principle on what kind of | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
91 window system Emacs uses to display its frames. @xref{Window Frame |
12067 | 92 Parameters}, for documentation of individual parameters you can specify. |
6547 | 93 @end defun |
94 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
95 @defvar before-make-frame-hook |
6547 | 96 A normal hook run by @code{make-frame} before it actually creates the |
97 frame. | |
98 @end defvar | |
99 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
100 @defvar after-make-frame-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
101 @tindex after-make-frame-functions |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
102 An abnormal hook run by @code{make-frame} after it creates the frame. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
103 Each function in @code{after-make-frame-hook} receives one argument, the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
104 frame just created. |
6547 | 105 @end defvar |
106 | |
12067 | 107 @node Multiple Displays |
108 @section Multiple Displays | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
109 @cindex multiple X displays |
12067 | 110 @cindex displays, multiple |
111 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
112 A single Emacs can talk to more than one X display. |
12067 | 113 Initially, Emacs uses just one display---the one chosen with the |
114 @code{DISPLAY} environment variable or with the @samp{--display} option | |
115 (@pxref{Initial Options,,, emacs, The GNU Emacs Manual}). To connect to | |
116 another display, use the command @code{make-frame-on-display} or specify | |
117 the @code{display} frame parameter when you create the frame. | |
118 | |
119 Emacs treats each X server as a separate terminal, giving each one its | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
120 own selected frame and its own minibuffer windows. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
121 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
122 A few Lisp variables are @dfn{terminal-local}; that is, they have a |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
123 separate binding for each terminal. The binding in effect at any time |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
124 is the one for the terminal that the currently selected frame belongs |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
125 to. These variables include @code{default-minibuffer-frame}, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
126 @code{defining-kbd-macro}, @code{last-kbd-macro}, and |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
127 @code{system-key-alist}. They are always terminal-local, and can never |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
128 be buffer-local (@pxref{Buffer-Local Variables}) or frame-local. |
12067 | 129 |
130 A single X server can handle more than one screen. A display name | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
131 @samp{@var{host}:@var{server}.@var{screen}} has three parts; the last |
12067 | 132 part specifies the screen number for a given server. When you use two |
133 screens belonging to one server, Emacs knows by the similarity in their | |
134 names that they share a single keyboard, and it treats them as a single | |
135 terminal. | |
136 | |
137 @deffn Command make-frame-on-display display &optional parameters | |
138 This creates a new frame on display @var{display}, taking the other | |
139 frame parameters from @var{parameters}. Aside from the @var{display} | |
140 argument, it is like @code{make-frame} (@pxref{Creating Frames}). | |
141 @end deffn | |
142 | |
143 @defun x-display-list | |
144 This returns a list that indicates which X displays Emacs has a | |
12098 | 145 connection to. The elements of the list are strings, and each one is |
146 a display name. | |
12067 | 147 @end defun |
148 | |
26388 | 149 @defun x-open-connection display &optional xrm-string must-succeed |
12067 | 150 This function opens a connection to the X display @var{display}. It |
151 does not create a frame on that display, but it permits you to check | |
152 that communication can be established with that display. | |
153 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
154 The optional argument @var{xrm-string}, if not @code{nil}, is a |
12098 | 155 string of resource names and values, in the same format used in the |
156 @file{.Xresources} file. The values you specify override the resource | |
157 values recorded in the X server itself; they apply to all Emacs frames | |
158 created on this display. Here's an example of what this string might | |
159 look like: | |
160 | |
161 @example | |
162 "*BorderWidth: 3\n*InternalBorder: 2\n" | |
163 @end example | |
164 | |
165 @xref{Resources}. | |
26388 | 166 |
167 If @var{must-succeed} is non-@code{nil}, failure to open the connection | |
168 terminates Emacs. Otherwise, it is an ordinary Lisp error. | |
12067 | 169 @end defun |
170 | |
171 @defun x-close-connection display | |
172 This function closes the connection to display @var{display}. Before | |
173 you can do this, you must first delete all the frames that were open on | |
174 that display (@pxref{Deleting Frames}). | |
175 @end defun | |
176 | |
6547 | 177 @node Frame Parameters |
178 @section Frame Parameters | |
179 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
180 A frame has many parameters that control its appearance and behavior. |
6547 | 181 Just what parameters a frame has depends on what display mechanism it |
182 uses. | |
183 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
184 Frame parameters exist mostly for the sake of window systems. A |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
185 terminal frame has a few parameters, mostly for compatibility's sake; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
186 only the @code{height}, @code{width}, @code{name}, @code{title}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
187 @code{menu-bar-lines}, @code{buffer-list} and @code{buffer-predicate} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
188 parameters do something special. If the terminal supports colors, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
189 parameters @code{foreground-color}, @code{background-color}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
190 @code{background-mode} and @code{display-type} are also meaningful. |
6547 | 191 |
192 @menu | |
193 * Parameter Access:: How to change a frame's parameters. | |
194 * Initial Parameters:: Specifying frame parameters when you make a frame. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
195 * Window Frame Parameters:: List of frame parameters for window systems. |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
196 * Size and Position:: Changing the size and position of a frame. |
6547 | 197 @end menu |
198 | |
199 @node Parameter Access | |
200 @subsection Access to Frame Parameters | |
201 | |
202 These functions let you read and change the parameter values of a | |
203 frame. | |
204 | |
26388 | 205 @defun frame-parameter frame parameter |
206 @tindex frame-parameter | |
207 This function returns the value of the parameter named @var{parameter} | |
208 of @var{frame}. If @var{frame} is @code{nil}, it returns the | |
209 selected frame's parameter. | |
210 @end defun | |
211 | |
6547 | 212 @defun frame-parameters frame |
213 The function @code{frame-parameters} returns an alist listing all the | |
214 parameters of @var{frame} and their values. | |
215 @end defun | |
216 | |
217 @defun modify-frame-parameters frame alist | |
218 This function alters the parameters of frame @var{frame} based on the | |
219 elements of @var{alist}. Each element of @var{alist} has the form | |
220 @code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a | |
221 parameter. If you don't mention a parameter in @var{alist}, its value | |
222 doesn't change. | |
223 @end defun | |
224 | |
225 @node Initial Parameters | |
226 @subsection Initial Frame Parameters | |
227 | |
228 You can specify the parameters for the initial startup frame | |
25875 | 229 by setting @code{initial-frame-alist} in your init file (@pxref{Init File}). |
6547 | 230 |
231 @defvar initial-frame-alist | |
232 This variable's value is an alist of parameter values used when creating | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
233 the initial window frame. You can set this variable to specify the |
16528
62be63ee468d
Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents:
15061
diff
changeset
|
234 appearance of the initial frame without altering subsequent frames. |
62be63ee468d
Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents:
15061
diff
changeset
|
235 Each element has the form: |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
236 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
237 @example |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
238 (@var{parameter} . @var{value}) |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
239 @end example |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
240 |
25875 | 241 Emacs creates the initial frame before it reads your init |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
242 file. After reading that file, Emacs checks @code{initial-frame-alist}, |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
243 and applies the parameter settings in the altered value to the already |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
244 created initial frame. |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
245 |
12098 | 246 If these settings affect the frame geometry and appearance, you'll see |
247 the frame appear with the wrong ones and then change to the specified | |
248 ones. If that bothers you, you can specify the same geometry and | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
249 appearance with X resources; those do take effect before the frame is |
12098 | 250 created. @xref{Resources X,, X Resources, emacs, The GNU Emacs Manual}. |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
251 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
252 X resource settings typically apply to all frames. If you want to |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
253 specify some X resources solely for the sake of the initial frame, and |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
254 you don't want them to apply to subsequent frames, here's how to achieve |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
255 this. Specify parameters in @code{default-frame-alist} to override the |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
256 X resources for subsequent frames; then, to prevent these from affecting |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
257 the initial frame, specify the same parameters in |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
258 @code{initial-frame-alist} with values that match the X resources. |
6547 | 259 @end defvar |
260 | |
12098 | 261 If these parameters specify a separate minibuffer-only frame with |
262 @code{(minibuffer . nil)}, and you have not created one, Emacs creates | |
263 one for you. | |
6547 | 264 |
265 @defvar minibuffer-frame-alist | |
266 This variable's value is an alist of parameter values used when creating | |
267 an initial minibuffer-only frame---if such a frame is needed, according | |
268 to the parameters for the main initial frame. | |
269 @end defvar | |
270 | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
271 @defvar default-frame-alist |
16528
62be63ee468d
Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents:
15061
diff
changeset
|
272 This is an alist specifying default values of frame parameters for all |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
273 Emacs frames---the first frame, and subsequent frames. When using the X |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
274 Window System, you can get the same results by means of X resources |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
275 in many cases. |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
276 @end defvar |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
277 |
12098 | 278 See also @code{special-display-frame-alist}, in @ref{Choosing Window}. |
279 | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
280 If you use options that specify window appearance when you invoke Emacs, |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
281 they take effect by adding elements to @code{default-frame-alist}. One |
12098 | 282 exception is @samp{-geometry}, which adds the specified position to |
283 @code{initial-frame-alist} instead. @xref{Command Arguments,,, emacs, | |
284 The GNU Emacs Manual}. | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
285 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
286 @node Window Frame Parameters |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
287 @subsection Window Frame Parameters |
6547 | 288 |
289 Just what parameters a frame has depends on what display mechanism it | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
290 uses. Here is a table of the parameters that have special meanings in a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
291 window frame; of these, @code{name}, @code{title}, @code{height}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
292 @code{width}, @code{buffer-list} and @code{buffer-predicate} provide |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
293 meaningful information in terminal frames. |
6547 | 294 |
295 @table @code | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
296 @item display |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
297 The display on which to open this frame. It should be a string of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
298 form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
299 @code{DISPLAY} environment variable. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
300 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
301 @item title |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
302 If a frame has a non-@code{nil} title, it appears in the window system's |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
303 border for the frame, and also in the mode line of windows in that frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
304 if @code{mode-line-frame-identification} uses @samp{%F} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
305 (@pxref{%-Constructs}). This is normally the case when Emacs is not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
306 using a window system, and can only display one frame at a time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
307 @xref{Frame Titles}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
308 |
6547 | 309 @item name |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
310 The name of the frame. The frame name serves as a default for the frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
311 title, if the @code{title} parameter is unspecified or @code{nil}. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
312 you don't specify a name, Emacs sets the frame name automatically |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
313 (@pxref{Frame Titles}). |
6547 | 314 |
315 If you specify the frame name explicitly when you create the frame, the | |
316 name is also used (instead of the name of the Emacs executable) when | |
317 looking up X resources for the frame. | |
318 | |
319 @item left | |
12067 | 320 The screen position of the left edge, in pixels, with respect to the |
321 left edge of the screen. The value may be a positive number @var{pos}, | |
322 or a list of the form @code{(+ @var{pos})} which permits specifying a | |
323 negative @var{pos} value. | |
324 | |
325 A negative number @minus{}@var{pos}, or a list of the form @code{(- | |
326 @var{pos})}, actually specifies the position of the right edge of the | |
12098 | 327 window with respect to the right edge of the screen. A positive value |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
328 of @var{pos} counts toward the left. @strong{Reminder:} if the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
329 parameter is a negative integer @minus{}@var{pos}, then @var{pos} is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
330 positive. |
6547 | 331 |
12388
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
332 Some window managers ignore program-specified positions. If you want to |
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
333 be sure the position you specify is not ignored, specify a |
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
334 non-@code{nil} value for the @code{user-position} parameter as well. |
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
335 |
6547 | 336 @item top |
12067 | 337 The screen position of the top edge, in pixels, with respect to the |
338 top edge of the screen. The value may be a positive number @var{pos}, | |
339 or a list of the form @code{(+ @var{pos})} which permits specifying a | |
340 negative @var{pos} value. | |
341 | |
342 A negative number @minus{}@var{pos}, or a list of the form @code{(- | |
343 @var{pos})}, actually specifies the position of the bottom edge of the | |
12098 | 344 window with respect to the bottom edge of the screen. A positive value |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
345 of @var{pos} counts toward the top. @strong{Reminder:} if the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
346 parameter is a negative integer @minus{}@var{pos}, then @var{pos} is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
347 positive. |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
348 |
12388
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
349 Some window managers ignore program-specified positions. If you want to |
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
350 be sure the position you specify is not ignored, specify a |
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
351 non-@code{nil} value for the @code{user-position} parameter as well. |
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
352 |
10220
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
353 @item icon-left |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
354 The screen position of the left edge @emph{of the frame's icon}, in |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
355 pixels, counting from the left edge of the screen. This takes effect if |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
356 and when the frame is iconified. |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
357 |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
358 @item icon-top |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
359 The screen position of the top edge @emph{of the frame's icon}, in |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
360 pixels, counting from the top edge of the screen. This takes effect if |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
361 and when the frame is iconified. |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
362 |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
363 @item user-position |
14658
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
364 When you create a frame and specify its screen position with the |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
365 @code{left} and @code{top} parameters, use this parameter to say whether |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
366 the specified position was user-specified (explicitly requested in some |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
367 way by a human user) or merely program-specified (chosen by a program). |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
368 A non-@code{nil} value says the position was user-specified. |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
369 |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
370 Window managers generally heed user-specified positions, and some heed |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
371 program-specified positions too. But many ignore program-specified |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
372 positions, placing the window in a default fashion or letting the user |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
373 place it with the mouse. Some window managers, including @code{twm}, |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
374 let the user specify whether to obey program-specified positions or |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
375 ignore them. |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
376 |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
377 When you call @code{make-frame}, you should specify a non-@code{nil} |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
378 value for this parameter if the values of the @code{left} and @code{top} |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
379 parameters represent the user's stated preference; otherwise, use |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
380 @code{nil}. |
6547 | 381 |
382 @item height | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
383 The height of the frame contents, in characters. (To get the height in |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
384 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) |
6547 | 385 |
386 @item width | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
387 The width of the frame contents, in characters. (To get the height in |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
388 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) |
6547 | 389 |
390 @item window-id | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
391 The number of the window-system window used by the frame |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
392 to contain the actual Emacs windows. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
393 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
394 @item outer-window-id |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
395 The number of the outermost window-system window used for the whole frame. |
6547 | 396 |
397 @item minibuffer | |
398 Whether this frame has its own minibuffer. The value @code{t} means | |
399 yes, @code{nil} means no, @code{only} means this frame is just a | |
12098 | 400 minibuffer. If the value is a minibuffer window (in some other frame), |
401 the new frame uses that minibuffer. | |
6547 | 402 |
12067 | 403 @item buffer-predicate |
404 The buffer-predicate function for this frame. The function | |
405 @code{other-buffer} uses this predicate (from the selected frame) to | |
406 decide which buffers it should consider, if the predicate is not | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
407 @code{nil}. It calls the predicate with one argument, a buffer, once for |
12067 | 408 each buffer; if the predicate returns a non-@code{nil} value, it |
409 considers that buffer. | |
410 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
411 @item buffer-list |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
412 A list of buffers that have been selected in this frame, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
413 ordered most-recently-selected first. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
414 |
6547 | 415 @item font |
416 The name of the font for displaying text in the frame. This is a | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
417 string, either a valid font name for your system or the name of an Emacs |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
418 fontset (@pxref{Fontsets}). Changing this frame parameter on a frame, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
419 also changes the font-related attributes of the default face on that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
420 frame. |
6547 | 421 |
422 @item auto-raise | |
423 Whether selecting the frame raises it (non-@code{nil} means yes). | |
424 | |
425 @item auto-lower | |
426 Whether deselecting the frame lowers it (non-@code{nil} means yes). | |
427 | |
428 @item vertical-scroll-bars | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
429 Whether the frame has scroll bars for vertical scrolling, and which side |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
430 of the frame they should be on. The possible values are @code{left}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
431 @code{right}, and @code{nil} for no scroll bars. |
6547 | 432 |
433 @item horizontal-scroll-bars | |
434 Whether the frame has scroll bars for horizontal scrolling | |
435 (non-@code{nil} means yes). (Horizontal scroll bars are not currently | |
436 implemented.) | |
437 | |
12067 | 438 @item scroll-bar-width |
439 The width of the vertical scroll bar, in pixels. | |
440 | |
6547 | 441 @item icon-type |
10759
fe6bdcb0d99f
Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents:
10220
diff
changeset
|
442 The type of icon to use for this frame when it is iconified. If the |
fe6bdcb0d99f
Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents:
10220
diff
changeset
|
443 value is a string, that specifies a file containing a bitmap to use. |
fe6bdcb0d99f
Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents:
10220
diff
changeset
|
444 Any other non-@code{nil} value specifies the default bitmap icon (a |
fe6bdcb0d99f
Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents:
10220
diff
changeset
|
445 picture of a gnu); @code{nil} specifies a text icon. |
6547 | 446 |
12098 | 447 @item icon-name |
448 The name to use in the icon for this frame, when and if the icon | |
449 appears. If this is @code{nil}, the frame's title is used. | |
450 | |
6547 | 451 @item foreground-color |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
452 The color to use for the image of a character. This is a string; the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
453 window system defines the meaningful color names. Changing this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
454 parameter is equivalent to changing the foreground color of the face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
455 @code{default} on the frame in question. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
456 |
6547 | 457 @item background-color |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
458 The color to use for the background of characters. Changing this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
459 parameter is equivalent to changing the foreground color of the face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
460 @code{default} on the frame in question. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
461 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
462 @item background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
463 This parameter is either @code{dark} or @code{light}, according |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
464 to whether the background color is a light one or a dark one. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
465 |
6547 | 466 @item mouse-color |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
467 The color for the mouse pointer. Changing this parameter is equivalent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
468 to changing the background color of face @code{mouse}. |
6547 | 469 |
470 @item cursor-color | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
471 The color for the cursor that shows point. Changing this parameter is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
472 equivalent to changing the background color of face @code{cursor}. |
6547 | 473 |
474 @item border-color | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
475 The color for the border of the frame. Changing this parameter is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
476 equivalent to changing the background color of face @code{border}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
477 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
478 @item scroll-bar-foreground |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
479 If non-@code{nil}, the color for the foreground of scroll bars. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
480 Changing this parameter is equivalent to setting the foreground color of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
481 face @code{scroll-bar}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
482 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
483 @item scroll-bar-background |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
484 If non-@code{nil}, the color for the background of scroll bars. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
485 Changing this parameter is equivalent to setting the foreground color of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
486 face @code{scroll-bar}. |
6547 | 487 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
488 @item display-type |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
489 This parameter describes the range of possible colors that can be used |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
490 in this frame. Its value is @code{color}, @code{grayscale} or |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
491 @code{mono}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
492 |
6547 | 493 @item cursor-type |
12067 | 494 The way to display the cursor. The legitimate values are @code{bar}, |
495 @code{box}, and @code{(bar . @var{width})}. The symbol @code{box} | |
496 specifies an ordinary black box overlaying the character after point; | |
497 that is the default. The symbol @code{bar} specifies a vertical bar | |
498 between characters as the cursor. @code{(bar . @var{width})} specifies | |
499 a bar @var{width} pixels wide. | |
6547 | 500 |
501 @item border-width | |
502 The width in pixels of the window border. | |
503 | |
504 @item internal-border-width | |
505 The distance in pixels between text and border. | |
506 | |
507 @item unsplittable | |
508 If non-@code{nil}, this frame's window is never split automatically. | |
509 | |
510 @item visibility | |
511 The state of visibility of the frame. There are three possibilities: | |
512 @code{nil} for invisible, @code{t} for visible, and @code{icon} for | |
513 iconified. @xref{Visibility of Frames}. | |
514 | |
515 @item menu-bar-lines | |
516 The number of lines to allocate at the top of the frame for a menu bar. | |
9453 | 517 The default is 1. @xref{Menu Bar}. (In Emacs versions that use the X |
518 toolkit, there is only one menu bar line; all that matters about the | |
519 number you specify is whether it is greater than zero.) | |
6547 | 520 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
521 @item screen-gamma |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
522 If this is a number, Emacs performs ``gamma correction'' on colors. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
523 value should be the screen gamma of your display, a floating point |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
524 number. Usual PC monitors have a screen gamma of 2.2. Smaller values |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
525 result in darker colors; you might want to try a screen gamma of 1.5 for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
526 LCD color displays. The viewing gamma Emacs uses is 0.4545 (1/2.2). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
527 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
528 @item tool-bar-lines |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
529 The number of lines to use for the toolbar. A value of @code{nil} means |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
530 don't display a tool bar. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
531 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
532 @ignore |
6547 | 533 @item parent-id |
534 @c ??? Not yet working. | |
535 The X window number of the window that should be the parent of this one. | |
536 Specifying this lets you create an Emacs window inside some other | |
537 application's window. (It is not certain this will be implemented; try | |
538 it and see if it works.) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
539 @end ignore |
6547 | 540 @end table |
541 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
542 @node Size and Position |
6547 | 543 @subsection Frame Size And Position |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
544 @cindex size of frame |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
545 @cindex screen size |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
546 @cindex frame size |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
547 @cindex resize frame |
6547 | 548 |
549 You can read or change the size and position of a frame using the | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
550 frame parameters @code{left}, @code{top}, @code{height}, and |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
551 @code{width}. Whatever geometry parameters you don't specify are chosen |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
552 by the window manager in its usual fashion. |
6547 | 553 |
554 Here are some special features for working with sizes and positions: | |
555 | |
556 @defun set-frame-position frame left top | |
12098 | 557 This function sets the position of the top left corner of @var{frame} to |
558 @var{left} and @var{top}. These arguments are measured in pixels, and | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
559 normally count from the top left corner of the screen. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
560 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
561 Negative parameter values position the bottom edge of the window up from |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
562 the bottom edge of the screen, or the right window edge to the left of |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
563 the right edge of the screen. It would probably be better if the values |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
564 were always counted from the left and top, so that negative arguments |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
565 would position the frame partly off the top or left edge of the screen, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
566 but it seems inadvisable to change that now. |
6547 | 567 @end defun |
568 | |
569 @defun frame-height &optional frame | |
570 @defunx frame-width &optional frame | |
571 These functions return the height and width of @var{frame}, measured in | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
572 lines and columns. If you don't supply @var{frame}, they use the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
573 selected frame. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
574 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
575 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
576 @defun screen-height |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
577 @defunx screen-width |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
578 These functions are old aliases for @code{frame-height} and |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
579 @code{frame-width}. When you are using a non-window terminal, the size |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
580 of the frame is normally the same as the size of the terminal screen. |
6547 | 581 @end defun |
582 | |
583 @defun frame-pixel-height &optional frame | |
584 @defunx frame-pixel-width &optional frame | |
585 These functions return the height and width of @var{frame}, measured in | |
586 pixels. If you don't supply @var{frame}, they use the selected frame. | |
587 @end defun | |
588 | |
589 @defun frame-char-height &optional frame | |
590 @defunx frame-char-width &optional frame | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
591 These functions return the height and width of a character in |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
592 @var{frame}, measured in pixels. The values depend on the choice of |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
593 font. If you don't supply @var{frame}, these functions use the selected |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
594 frame. |
6547 | 595 @end defun |
596 | |
597 @defun set-frame-size frame cols rows | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
598 This function sets the size of @var{frame}, measured in characters; |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
599 @var{cols} and @var{rows} specify the new width and height. |
6547 | 600 |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
601 To set the size based on values measured in pixels, use |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
602 @code{frame-char-height} and @code{frame-char-width} to convert |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
603 them to units of characters. |
6547 | 604 @end defun |
605 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
606 @defun set-frame-height frame lines &optional pretend |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
607 This function resizes @var{frame} to a height of @var{lines} lines. The |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
608 sizes of existing windows in @var{frame} are altered proportionally to |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
609 fit. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
610 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
611 If @var{pretend} is non-@code{nil}, then Emacs displays @var{lines} |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
612 lines of output in @var{frame}, but does not change its value for the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
613 actual height of the frame. This is only useful for a terminal frame. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
614 Using a smaller height than the terminal actually implements may be |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
615 useful to reproduce behavior observed on a smaller screen, or if the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
616 terminal malfunctions when using its whole screen. Setting the frame |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
617 height ``for real'' does not always work, because knowing the correct |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
618 actual size may be necessary for correct cursor positioning on a |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
619 terminal frame. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
620 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
621 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
622 @defun set-frame-width frame width &optional pretend |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
623 This function sets the width of @var{frame}, measured in characters. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
624 The argument @var{pretend} has the same meaning as in |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
625 @code{set-frame-height}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
626 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
627 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
628 @findex set-screen-height |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
629 @findex set-screen-width |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
630 The older functions @code{set-screen-height} and |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
631 @code{set-screen-width} were used to specify the height and width of the |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
632 screen, in Emacs versions that did not support multiple frames. They |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
633 are semi-obsolete, but still work; they apply to the selected frame. |
6547 | 634 |
635 @defun x-parse-geometry geom | |
636 @cindex geometry specification | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
637 The function @code{x-parse-geometry} converts a standard X window |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
638 geometry string to an alist that you can use as part of the argument to |
6547 | 639 @code{make-frame}. |
640 | |
641 The alist describes which parameters were specified in @var{geom}, and | |
642 gives the values specified for them. Each element looks like | |
643 @code{(@var{parameter} . @var{value})}. The possible @var{parameter} | |
644 values are @code{left}, @code{top}, @code{width}, and @code{height}. | |
645 | |
12067 | 646 For the size parameters, the value must be an integer. The position |
647 parameter names @code{left} and @code{top} are not totally accurate, | |
648 because some values indicate the position of the right or bottom edges | |
649 instead. These are the @var{value} possibilities for the position | |
650 parameters: | |
651 | |
652 @table @asis | |
653 @item an integer | |
654 A positive integer relates the left edge or top edge of the window to | |
655 the left or top edge of the screen. A negative integer relates the | |
656 right or bottom edge of the window to the right or bottom edge of the | |
657 screen. | |
658 | |
12098 | 659 @item @code{(+ @var{position})} |
12067 | 660 This specifies the position of the left or top edge of the window |
661 relative to the left or top edge of the screen. The integer | |
662 @var{position} may be positive or negative; a negative value specifies a | |
663 position outside the screen. | |
664 | |
12098 | 665 @item @code{(- @var{position})} |
12067 | 666 This specifies the position of the right or bottom edge of the window |
667 relative to the right or bottom edge of the screen. The integer | |
668 @var{position} may be positive or negative; a negative value specifies a | |
669 position outside the screen. | |
670 @end table | |
671 | |
672 Here is an example: | |
673 | |
12098 | 674 @example |
6547 | 675 (x-parse-geometry "35x70+0-0") |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
676 @result{} ((height . 70) (width . 35) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
677 (top - 0) (left . 0)) |
12098 | 678 @end example |
6547 | 679 @end defun |
680 | |
12067 | 681 @node Frame Titles |
682 @section Frame Titles | |
683 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
684 Every frame has a @code{name} parameter; this serves as the default |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
685 for the frame title which window systems typically display at the top of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
686 the frame. You can specify a name explicitly by setting the @code{name} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
687 frame property. |
12067 | 688 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
689 Normally you don't specify the name explicitly, and Emacs computes the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
690 frame name automatically based on a template stored in the variable |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
691 @code{frame-title-format}. Emacs recomputes the name each time the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
692 frame is redisplayed. |
12067 | 693 |
694 @defvar frame-title-format | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
695 This variable specifies how to compute a name for a frame when you have |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
696 not explicitly specified one. The variable's value is actually a mode |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
697 line construct, just like @code{mode-line-format}. @xref{Mode Line |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
698 Data}. |
12067 | 699 @end defvar |
700 | |
701 @defvar icon-title-format | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
702 This variable specifies how to compute the name for an iconified frame, |
12067 | 703 when you have not explicitly specified the frame title. This title |
704 appears in the icon itself. | |
705 @end defvar | |
706 | |
707 @defvar multiple-frames | |
708 This variable is set automatically by Emacs. Its value is @code{t} when | |
709 there are two or more frames (not counting minibuffer-only frames or | |
710 invisible frames). The default value of @code{frame-title-format} uses | |
711 @code{multiple-frames} so as to put the buffer name in the frame title | |
712 only when there is more than one frame. | |
713 @end defvar | |
714 | |
6547 | 715 @node Deleting Frames |
716 @section Deleting Frames | |
717 @cindex deletion of frames | |
718 | |
719 Frames remain potentially visible until you explicitly @dfn{delete} | |
720 them. A deleted frame cannot appear on the screen, but continues to | |
721 exist as a Lisp object until there are no references to it. There is no | |
722 way to cancel the deletion of a frame aside from restoring a saved frame | |
723 configuration (@pxref{Frame Configurations}); this is similar to the | |
724 way windows behave. | |
725 | |
26388 | 726 @deffn Command delete-frame &optional frame force |
6547 | 727 This function deletes the frame @var{frame}. By default, @var{frame} is |
26388 | 728 the selected frame. |
729 | |
730 A frame cannot be deleted if its minibuffer is used by other frames. | |
731 Normally, you cannot delete a frame if all other frames are invisible, | |
732 but if the @var{force} is non-@code{nil}, then you are allowed to do so. | |
6547 | 733 @end deffn |
734 | |
735 @defun frame-live-p frame | |
736 The function @code{frame-live-p} returns non-@code{nil} if the frame | |
737 @var{frame} has not been deleted. | |
738 @end defun | |
739 | |
12067 | 740 Some window managers provide a command to delete a window. These work |
12125
995be67f3fd1
updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
741 by sending a special message to the program that operates the window. |
12067 | 742 When Emacs gets one of these commands, it generates a |
743 @code{delete-frame} event, whose normal definition is a command that | |
744 calls the function @code{delete-frame}. @xref{Misc Events}. | |
745 | |
6547 | 746 @node Finding All Frames |
747 @section Finding All Frames | |
748 | |
749 @defun frame-list | |
750 The function @code{frame-list} returns a list of all the frames that | |
751 have not been deleted. It is analogous to @code{buffer-list} for | |
752 buffers. The list that you get is newly created, so modifying the list | |
753 doesn't have any effect on the internals of Emacs. | |
754 @end defun | |
755 | |
756 @defun visible-frame-list | |
757 This function returns a list of just the currently visible frames. | |
12067 | 758 @xref{Visibility of Frames}. (Terminal frames always count as |
759 ``visible'', even though only the selected one is actually displayed.) | |
6547 | 760 @end defun |
761 | |
762 @defun next-frame &optional frame minibuf | |
763 The function @code{next-frame} lets you cycle conveniently through all | |
764 the frames from an arbitrary starting point. It returns the ``next'' | |
765 frame after @var{frame} in the cycle. If @var{frame} is omitted or | |
766 @code{nil}, it defaults to the selected frame. | |
767 | |
768 The second argument, @var{minibuf}, says which frames to consider: | |
769 | |
770 @table @asis | |
771 @item @code{nil} | |
772 Exclude minibuffer-only frames. | |
773 @item @code{visible} | |
774 Consider all visible frames. | |
12098 | 775 @item 0 |
776 Consider all visible or iconified frames. | |
6547 | 777 @item a window |
778 Consider only the frames using that particular window as their | |
779 minibuffer. | |
780 @item anything else | |
781 Consider all frames. | |
782 @end table | |
783 @end defun | |
784 | |
785 @defun previous-frame &optional frame minibuf | |
786 Like @code{next-frame}, but cycles through all frames in the opposite | |
787 direction. | |
788 @end defun | |
789 | |
12098 | 790 See also @code{next-window} and @code{previous-window}, in @ref{Cyclic |
791 Window Ordering}. | |
792 | |
6547 | 793 @node Frames and Windows |
794 @section Frames and Windows | |
795 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
796 Each window is part of one and only one frame; you can get the frame |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
797 with @code{window-frame}. |
6547 | 798 |
799 @defun window-frame window | |
800 This function returns the frame that @var{window} is on. | |
801 @end defun | |
802 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
803 All the non-minibuffer windows in a frame are arranged in a cyclic |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
804 order. The order runs from the frame's top window, which is at the |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
805 upper left corner, down and to the right, until it reaches the window at |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
806 the lower right corner (always the minibuffer window, if the frame has |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
807 one), and then it moves back to the top. @xref{Cyclic Window Ordering}. |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
808 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
809 @defun frame-first-window frame |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
810 This returns the topmost, leftmost window of frame @var{frame}. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
811 @end defun |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
812 |
6547 | 813 At any time, exactly one window on any frame is @dfn{selected within the |
814 frame}. The significance of this designation is that selecting the | |
815 frame also selects this window. You can get the frame's current | |
816 selected window with @code{frame-selected-window}. | |
817 | |
818 @defun frame-selected-window frame | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
819 This function returns the window on @var{frame} that is selected within |
6547 | 820 @var{frame}. |
821 @end defun | |
822 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
823 Conversely, selecting a window for Emacs with @code{select-window} also |
6547 | 824 makes that window selected within its frame. @xref{Selecting Windows}. |
825 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
826 Another function that (usually) returns one of the windows in a given |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
827 frame is @code{minibuffer-window}. @xref{Minibuffer Misc}. |
12098 | 828 |
6547 | 829 @node Minibuffers and Frames |
830 @section Minibuffers and Frames | |
831 | |
832 Normally, each frame has its own minibuffer window at the bottom, which | |
833 is used whenever that frame is selected. If the frame has a minibuffer, | |
834 you can get it with @code{minibuffer-window} (@pxref{Minibuffer Misc}). | |
835 | |
836 However, you can also create a frame with no minibuffer. Such a frame | |
837 must use the minibuffer window of some other frame. When you create the | |
12098 | 838 frame, you can specify explicitly the minibuffer window to use (in some |
839 other frame). If you don't, then the minibuffer is found in the frame | |
840 which is the value of the variable @code{default-minibuffer-frame}. Its | |
841 value should be a frame that does have a minibuffer. | |
6547 | 842 |
843 If you use a minibuffer-only frame, you might want that frame to raise | |
844 when you enter the minibuffer. If so, set the variable | |
845 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}. | |
846 | |
12067 | 847 @defvar default-minibuffer-frame |
848 This variable specifies the frame to use for the minibuffer window, by | |
12098 | 849 default. It is always local to the current terminal and cannot be |
12067 | 850 buffer-local. @xref{Multiple Displays}. |
851 @end defvar | |
852 | |
6547 | 853 @node Input Focus |
854 @section Input Focus | |
855 @cindex input focus | |
856 @cindex selected frame | |
857 | |
858 At any time, one frame in Emacs is the @dfn{selected frame}. The selected | |
859 window always resides on the selected frame. | |
860 | |
861 @defun selected-frame | |
862 This function returns the selected frame. | |
863 @end defun | |
864 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
865 Some window systems and window managers direct keyboard input to the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
866 window object that the mouse is in; others require explicit clicks or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
867 commands to @dfn{shift the focus} to various window objects. Either |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
868 way, Emacs automatically keeps track of which frame has the focus. |
6547 | 869 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
870 Lisp programs can also switch frames ``temporarily'' by calling the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
871 function @code{select-frame}. This does not alter the window system's |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
872 concept of focus; rather, it escapes from the window manager's control |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
873 until that control is somehow reasserted. |
6547 | 874 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
875 When using a text-only terminal, only the selected terminal frame is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
876 actually displayed on the terminal. @code{switch-frame} is the only way |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
877 to switch frames, and the change lasts until overridden by a subsequent |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
878 call to @code{switch-frame}. Each terminal screen except for the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
879 initial one has a number, and the number of the selected frame appears |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
880 in the mode line before the buffer name (@pxref{Mode Line Variables}). |
12067 | 881 |
6547 | 882 @c ??? This is not yet implemented properly. |
883 @defun select-frame frame | |
884 This function selects frame @var{frame}, temporarily disregarding the | |
12067 | 885 focus of the X server if any. The selection of @var{frame} lasts until |
886 the next time the user does something to select a different frame, or | |
887 until the next time this function is called. | |
6547 | 888 @end defun |
889 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
890 Emacs cooperates with the window system by arranging to select frames as |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
891 the server and window manager request. It does so by generating a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
892 special kind of input event, called a @dfn{focus} event, when |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
893 appropriate. The command loop handles a focus event by calling |
13155
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
894 @code{handle-switch-frame}. @xref{Focus Events}. |
6547 | 895 |
896 @deffn Command handle-switch-frame frame | |
897 This function handles a focus event by selecting frame @var{frame}. | |
898 | |
899 Focus events normally do their job by invoking this command. | |
900 Don't call it for any other reason. | |
901 @end deffn | |
902 | |
903 @defun redirect-frame-focus frame focus-frame | |
904 This function redirects focus from @var{frame} to @var{focus-frame}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
905 This means that @var{focus-frame} will receive subsequent keystrokes and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
906 events intended for @var{frame}. After such an event, the value of |
6547 | 907 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame |
908 events specifying @var{frame} will instead select @var{focus-frame}. | |
909 | |
910 If @var{focus-frame} is @code{nil}, that cancels any existing | |
911 redirection for @var{frame}, which therefore once again receives its own | |
912 events. | |
913 | |
914 One use of focus redirection is for frames that don't have minibuffers. | |
915 These frames use minibuffers on other frames. Activating a minibuffer | |
916 on another frame redirects focus to that frame. This puts the focus on | |
917 the minibuffer's frame, where it belongs, even though the mouse remains | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
918 in the frame that activated the minibuffer. |
6547 | 919 |
920 Selecting a frame can also change focus redirections. Selecting frame | |
921 @code{bar}, when @code{foo} had been selected, changes any redirections | |
922 pointing to @code{foo} so that they point to @code{bar} instead. This | |
923 allows focus redirection to work properly when the user switches from | |
924 one frame to another using @code{select-window}. | |
925 | |
926 This means that a frame whose focus is redirected to itself is treated | |
927 differently from a frame whose focus is not redirected. | |
928 @code{select-frame} affects the former but not the latter. | |
929 | |
930 The redirection lasts until @code{redirect-frame-focus} is called to | |
931 change it. | |
932 @end defun | |
933 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
934 @defopt focus-follows-mouse |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
935 This option is how you inform Emacs whether the window manager transfers |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
936 focus when the user moves the mouse. Non-@code{nil} says that it does. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
937 When this is so, the command @code{other-frame} moves the mouse to a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
938 position consistent with the new selected frame. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
939 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
940 |
6547 | 941 @node Visibility of Frames |
942 @section Visibility of Frames | |
943 @cindex visible frame | |
944 @cindex invisible frame | |
945 @cindex iconified frame | |
946 @cindex frame visibility | |
947 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
948 A window frame may be @dfn{visible}, @dfn{invisible}, or |
12067 | 949 @dfn{iconified}. If it is visible, you can see its contents. If it is |
950 iconified, the frame's contents do not appear on the screen, but an icon | |
951 does. If the frame is invisible, it doesn't show on the screen, not | |
952 even as an icon. | |
953 | |
954 Visibility is meaningless for terminal frames, since only the selected | |
955 one is actually displayed in any case. | |
6547 | 956 |
957 @deffn Command make-frame-visible &optional frame | |
958 This function makes frame @var{frame} visible. If you omit @var{frame}, | |
959 it makes the selected frame visible. | |
960 @end deffn | |
961 | |
962 @deffn Command make-frame-invisible &optional frame | |
963 This function makes frame @var{frame} invisible. If you omit | |
964 @var{frame}, it makes the selected frame invisible. | |
965 @end deffn | |
966 | |
967 @deffn Command iconify-frame &optional frame | |
968 This function iconifies frame @var{frame}. If you omit @var{frame}, it | |
969 iconifies the selected frame. | |
970 @end deffn | |
971 | |
972 @defun frame-visible-p frame | |
973 This returns the visibility status of frame @var{frame}. The value is | |
974 @code{t} if @var{frame} is visible, @code{nil} if it is invisible, and | |
975 @code{icon} if it is iconified. | |
976 @end defun | |
977 | |
978 The visibility status of a frame is also available as a frame | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
979 parameter. You can read or change it as such. @xref{Window Frame |
6547 | 980 Parameters}. |
981 | |
12067 | 982 The user can iconify and deiconify frames with the window manager. |
983 This happens below the level at which Emacs can exert any control, but | |
984 Emacs does provide events that you can use to keep track of such | |
985 changes. @xref{Misc Events}. | |
986 | |
6547 | 987 @node Raising and Lowering |
988 @section Raising and Lowering Frames | |
989 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
990 Most window systems use a desktop metaphor. Part of this metaphor is |
6547 | 991 the idea that windows are stacked in a notional third dimension |
992 perpendicular to the screen surface, and thus ordered from ``highest'' | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
993 to ``lowest''. Where two windows overlap, the one higher up covers |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
994 the one underneath. Even a window at the bottom of the stack can be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
995 seen if no other window overlaps it. |
6547 | 996 |
997 @cindex raising a frame | |
998 @cindex lowering a frame | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
999 A window's place in this ordering is not fixed; in fact, users tend |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1000 to change the order frequently. @dfn{Raising} a window means moving |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1001 it ``up'', to the top of the stack. @dfn{Lowering} a window means |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1002 moving it to the bottom of the stack. This motion is in the notional |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1003 third dimension only, and does not change the position of the window |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1004 on the screen. |
6547 | 1005 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1006 You can raise and lower Emacs frame Windows with these functions: |
6547 | 1007 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1008 @deffn Command raise-frame &optional frame |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1009 This function raises frame @var{frame} (default, the selected frame). |
12067 | 1010 @end deffn |
6547 | 1011 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1012 @deffn Command lower-frame &optional frame |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1013 This function lowers frame @var{frame} (default, the selected frame). |
12067 | 1014 @end deffn |
6547 | 1015 |
1016 @defopt minibuffer-auto-raise | |
1017 If this is non-@code{nil}, activation of the minibuffer raises the frame | |
1018 that the minibuffer window is in. | |
1019 @end defopt | |
1020 | |
1021 You can also enable auto-raise (raising automatically when a frame is | |
1022 selected) or auto-lower (lowering automatically when it is deselected) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1023 for any frame using frame parameters. @xref{Window Frame Parameters}. |
6547 | 1024 |
1025 @node Frame Configurations | |
1026 @section Frame Configurations | |
1027 @cindex frame configuration | |
1028 | |
1029 A @dfn{frame configuration} records the current arrangement of frames, | |
1030 all their properties, and the window configuration of each one. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1031 (@xref{Window Configurations}.) |
6547 | 1032 |
1033 @defun current-frame-configuration | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1034 This function returns a frame configuration list that describes |
6547 | 1035 the current arrangement of frames and their contents. |
1036 @end defun | |
1037 | |
26388 | 1038 @defun set-frame-configuration configuration &optional nodelete |
6547 | 1039 This function restores the state of frames described in |
1040 @var{configuration}. | |
26388 | 1041 |
1042 Ordinarily, this function deletes all existing frames not listed in | |
1043 @var{configuration}. But if @var{nodelete} is non-@code{nil}, the | |
1044 unwanted frames are iconified instead. | |
6547 | 1045 @end defun |
1046 | |
1047 @node Mouse Tracking | |
1048 @section Mouse Tracking | |
1049 @cindex mouse tracking | |
1050 @cindex tracking the mouse | |
1051 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1052 Sometimes it is useful to @dfn{track} the mouse, which means to display |
6547 | 1053 something to indicate where the mouse is and move the indicator as the |
1054 mouse moves. For efficient mouse tracking, you need a way to wait until | |
1055 the mouse actually moves. | |
1056 | |
1057 The convenient way to track the mouse is to ask for events to represent | |
1058 mouse motion. Then you can wait for motion by waiting for an event. In | |
1059 addition, you can easily handle any other sorts of events that may | |
1060 occur. That is useful, because normally you don't want to track the | |
1061 mouse forever---only until some other event, such as the release of a | |
1062 button. | |
1063 | |
1064 @defspec track-mouse body@dots{} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1065 This special form executes @var{body}, with generation of mouse motion |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1066 events enabled. Typically @var{body} would use @code{read-event} to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1067 read the motion events and modify the display accordingly. @xref{Motion |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1068 Events}, for the format of mouse motion events. |
6547 | 1069 |
1070 The value of @code{track-mouse} is that of the last form in @var{body}. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1071 You should design @var{body} to return when it sees the up-event that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1072 indicates the release of the button, or whatever kind of event means |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1073 it is time to stop tracking. |
6547 | 1074 @end defspec |
1075 | |
1076 The usual purpose of tracking mouse motion is to indicate on the screen | |
1077 the consequences of pushing or releasing a button at the current | |
1078 position. | |
1079 | |
12098 | 1080 In many cases, you can avoid the need to track the mouse by using |
1081 the @code{mouse-face} text property (@pxref{Special Properties}). | |
1082 That works at a much lower level and runs more smoothly than | |
1083 Lisp-level mouse tracking. | |
1084 | |
6547 | 1085 @ignore |
1086 @c These are not implemented yet. | |
1087 | |
1088 These functions change the screen appearance instantaneously. The | |
1089 effect is transient, only until the next ordinary Emacs redisplay. That | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1090 is OK for mouse tracking, since it doesn't make sense for mouse tracking |
6547 | 1091 to change the text, and the body of @code{track-mouse} normally reads |
1092 the events itself and does not do redisplay. | |
1093 | |
1094 @defun x-contour-region window beg end | |
1095 This function draws lines to make a box around the text from @var{beg} | |
1096 to @var{end}, in window @var{window}. | |
1097 @end defun | |
1098 | |
1099 @defun x-uncontour-region window beg end | |
1100 This function erases the lines that would make a box around the text | |
1101 from @var{beg} to @var{end}, in window @var{window}. Use it to remove | |
1102 a contour that you previously made by calling @code{x-contour-region}. | |
1103 @end defun | |
1104 | |
1105 @defun x-draw-rectangle frame left top right bottom | |
1106 This function draws a hollow rectangle on frame @var{frame} with the | |
1107 specified edge coordinates, all measured in pixels from the inside top | |
1108 left corner. It uses the cursor color, the one used for indicating the | |
1109 location of point. | |
1110 @end defun | |
1111 | |
1112 @defun x-erase-rectangle frame left top right bottom | |
1113 This function erases a hollow rectangle on frame @var{frame} with the | |
1114 specified edge coordinates, all measured in pixels from the inside top | |
1115 left corner. Erasure means redrawing the text and background that | |
1116 normally belong in the specified rectangle. | |
1117 @end defun | |
1118 @end ignore | |
1119 | |
1120 @node Mouse Position | |
1121 @section Mouse Position | |
1122 @cindex mouse position | |
1123 @cindex position of mouse | |
1124 | |
1125 The functions @code{mouse-position} and @code{set-mouse-position} | |
1126 give access to the current position of the mouse. | |
1127 | |
1128 @defun mouse-position | |
1129 This function returns a description of the position of the mouse. The | |
1130 value looks like @code{(@var{frame} @var{x} . @var{y})}, where @var{x} | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1131 and @var{y} are integers giving the position in characters relative to |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1132 the top left corner of the inside of @var{frame}. |
6547 | 1133 @end defun |
1134 | |
1135 @defun set-mouse-position frame x y | |
1136 This function @dfn{warps the mouse} to position @var{x}, @var{y} in | |
1137 frame @var{frame}. The arguments @var{x} and @var{y} are integers, | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1138 giving the position in characters relative to the top left corner of the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1139 inside of @var{frame}. If @var{frame} is not visible, this function |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1140 does nothing. The return value is not significant. |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1141 @end defun |
6547 | 1142 |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1143 @defun mouse-pixel-position |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1144 This function is like @code{mouse-position} except that it returns |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1145 coordinates in units of pixels rather than units of characters. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1146 @end defun |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1147 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1148 @defun set-mouse-pixel-position frame x y |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1149 This function warps the mouse like @code{set-mouse-position} except that |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1150 @var{x} and @var{y} are in units of pixels rather than units of |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1151 characters. These coordinates are not required to be within the frame. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1152 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1153 If @var{frame} is not visible, this function does nothing. The return |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1154 value is not significant. |
6547 | 1155 @end defun |
1156 | |
1157 @need 3000 | |
1158 | |
1159 @node Pop-Up Menus | |
1160 @section Pop-Up Menus | |
1161 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1162 When using a window system, a Lisp program can pop up a menu so that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1163 the user can choose an alternative with the mouse. |
12067 | 1164 |
6547 | 1165 @defun x-popup-menu position menu |
1166 This function displays a pop-up menu and returns an indication of | |
1167 what selection the user makes. | |
1168 | |
1169 The argument @var{position} specifies where on the screen to put the | |
1170 menu. It can be either a mouse button event (which says to put the menu | |
1171 where the user actuated the button) or a list of this form: | |
1172 | |
1173 @example | |
1174 ((@var{xoffset} @var{yoffset}) @var{window}) | |
1175 @end example | |
1176 | |
1177 @noindent | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1178 where @var{xoffset} and @var{yoffset} are coordinates, measured in |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1179 pixels, counting from the top left corner of @var{window}'s frame. |
6547 | 1180 |
1181 If @var{position} is @code{t}, it means to use the current mouse | |
1182 position. If @var{position} is @code{nil}, it means to precompute the | |
1183 key binding equivalents for the keymaps specified in @var{menu}, | |
1184 without actually displaying or popping up the menu. | |
1185 | |
1186 The argument @var{menu} says what to display in the menu. It can be a | |
1187 keymap or a list of keymaps (@pxref{Menu Keymaps}). Alternatively, it | |
1188 can have the following form: | |
1189 | |
1190 @example | |
1191 (@var{title} @var{pane1} @var{pane2}...) | |
1192 @end example | |
1193 | |
1194 @noindent | |
1195 where each pane is a list of form | |
1196 | |
1197 @example | |
12098 | 1198 (@var{title} (@var{line} . @var{item})...) |
6547 | 1199 @end example |
1200 | |
1201 Each @var{line} should be a string, and each @var{item} should be the | |
1202 value to return if that @var{line} is chosen. | |
1203 @end defun | |
1204 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1205 @strong{Usage note:} Don't use @code{x-popup-menu} to display a menu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1206 if you could do the job with a prefix key defined with a menu keymap. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1207 If you use a menu keymap to implement a menu, @kbd{C-h c} and @kbd{C-h |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1208 a} can see the individual items in that menu and provide help for them. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1209 If instead you implement the menu by defining a command that calls |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1210 @code{x-popup-menu}, the help facilities cannot know what happens inside |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1211 that command, so they cannot give any help for the menu's items. |
14200
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1212 |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1213 The menu bar mechanism, which lets you switch between submenus by |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1214 moving the mouse, cannot look within the definition of a command to see |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1215 that it calls @code{x-popup-menu}. Therefore, if you try to implement a |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1216 submenu using @code{x-popup-menu}, it cannot work with the menu bar in |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1217 an integrated fashion. This is why all menu bar submenus are |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1218 implemented with menu keymaps within the parent menu, and never with |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1219 @code{x-popup-menu}. @xref{Menu Bar}, |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1220 |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1221 If you want a menu bar submenu to have contents that vary, you should |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1222 still use a menu keymap to implement it. To make the contents vary, add |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1223 a hook function to @code{menu-bar-update-hook} to update the contents of |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1224 the menu keymap as necessary. |
6547 | 1225 |
1226 @node Dialog Boxes | |
1227 @section Dialog Boxes | |
1228 @cindex dialog boxes | |
1229 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1230 A dialog box is a variant of a pop-up menu---it looks a little |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1231 different, it always appears in the center of a frame, and it has just |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1232 one level and one pane. The main use of dialog boxes is for asking |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1233 questions that the user can answer with ``yes'', ``no'', and a few other |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1234 alternatives. The functions @code{y-or-n-p} and @code{yes-or-no-p} use |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1235 dialog boxes instead of the keyboard, when called from commands invoked |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1236 by mouse clicks. |
6547 | 1237 |
1238 @defun x-popup-dialog position contents | |
1239 This function displays a pop-up dialog box and returns an indication of | |
1240 what selection the user makes. The argument @var{contents} specifies | |
1241 the alternatives to offer; it has this format: | |
1242 | |
1243 @example | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1244 (@var{title} (@var{string} . @var{value})@dots{}) |
6547 | 1245 @end example |
1246 | |
1247 @noindent | |
1248 which looks like the list that specifies a single pane for | |
1249 @code{x-popup-menu}. | |
1250 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1251 The return value is @var{value} from the chosen alternative. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1252 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1253 An element of the list may be just a string instead of a cons cell |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1254 @code{(@var{string} . @var{value})}. That makes a box that cannot |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1255 be selected. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1256 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1257 If @code{nil} appears in the list, it separates the left-hand items from |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1258 the right-hand items; items that precede the @code{nil} appear on the |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1259 left, and items that follow the @code{nil} appear on the right. If you |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1260 don't include a @code{nil} in the list, then approximately half the |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1261 items appear on each side. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1262 |
6547 | 1263 Dialog boxes always appear in the center of a frame; the argument |
1264 @var{position} specifies which frame. The possible values are as in | |
1265 @code{x-popup-menu}, but the precise coordinates don't matter; only the | |
1266 frame matters. | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1267 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1268 In some configurations, Emacs cannot display a real dialog box; so |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1269 instead it displays the same items in a pop-up menu in the center of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1270 frame. |
6547 | 1271 @end defun |
1272 | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1273 @node Pointer Shapes |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1274 @section Pointer Shapes |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1275 @cindex pointer shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1276 @cindex mouse pointer shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1277 |
12067 | 1278 These variables specify which shape to use for the mouse pointer in |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1279 various situations, when using the X Window System: |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1280 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1281 @table @code |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1282 @item x-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1283 @vindex x-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1284 This variable specifies the pointer shape to use ordinarily in the Emacs |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1285 frame. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1286 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1287 @item x-sensitive-text-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1288 @vindex x-sensitive-text-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1289 This variable specifies the pointer shape to use when the mouse |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1290 is over mouse-sensitive text. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1291 @end table |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1292 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1293 These variables affect newly created frames. They do not normally |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1294 affect existing frames; however, if you set the mouse color of a frame, |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1295 that also updates its pointer shapes based on the current values of |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1296 these variables. @xref{Window Frame Parameters}. |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1297 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1298 The values you can use, to specify either of these pointer shapes, are |
15061 | 1299 defined in the file @file{lisp/term/x-win.el}. Use @kbd{M-x apropos |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1300 @key{RET} x-pointer @key{RET}} to see a list of them. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1301 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1302 @node Window System Selections |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1303 @section Window System Selections |
6547 | 1304 @cindex selection (for X windows) |
1305 | |
1306 The X server records a set of @dfn{selections} which permit transfer of | |
1307 data between application programs. The various selections are | |
1308 distinguished by @dfn{selection types}, represented in Emacs by | |
1309 symbols. X clients including Emacs can read or set the selection for | |
1310 any given type. | |
1311 | |
1312 @defun x-set-selection type data | |
1313 This function sets a ``selection'' in the X server. It takes two | |
1314 arguments: a selection type @var{type}, and the value to assign to it, | |
1315 @var{data}. If @var{data} is @code{nil}, it means to clear out the | |
1316 selection. Otherwise, @var{data} may be a string, a symbol, an integer | |
1317 (or a cons of two integers or list of two integers), an overlay, or a | |
1318 cons of two markers pointing to the same buffer. An overlay or a pair | |
1319 of markers stands for text in the overlay or between the markers. | |
1320 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1321 The argument @var{data} may also be a vector of valid non-vector |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1322 selection values. |
6547 | 1323 |
1324 Each possible @var{type} has its own selection value, which changes | |
1325 independently. The usual values of @var{type} are @code{PRIMARY} and | |
1326 @code{SECONDARY}; these are symbols with upper-case names, in accord | |
1327 with X Window System conventions. The default is @code{PRIMARY}. | |
1328 @end defun | |
1329 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1330 @defun x-get-selection &optional type data-type |
6547 | 1331 This function accesses selections set up by Emacs or by other X |
1332 clients. It takes two optional arguments, @var{type} and | |
1333 @var{data-type}. The default for @var{type}, the selection type, is | |
1334 @code{PRIMARY}. | |
1335 | |
1336 The @var{data-type} argument specifies the form of data conversion to | |
1337 use, to convert the raw data obtained from another X client into Lisp | |
1338 data. Meaningful values include @code{TEXT}, @code{STRING}, | |
1339 @code{TARGETS}, @code{LENGTH}, @code{DELETE}, @code{FILE_NAME}, | |
1340 @code{CHARACTER_POSITION}, @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, | |
1341 @code{OWNER_OS}, @code{HOST_NAME}, @code{USER}, @code{CLASS}, | |
1342 @code{NAME}, @code{ATOM}, and @code{INTEGER}. (These are symbols with | |
1343 upper-case names in accord with X conventions.) The default for | |
1344 @var{data-type} is @code{STRING}. | |
1345 @end defun | |
1346 | |
1347 @cindex cut buffer | |
1348 The X server also has a set of numbered @dfn{cut buffers} which can | |
1349 store text or other data being moved between applications. Cut buffers | |
1350 are considered obsolete, but Emacs supports them for the sake of X | |
1351 clients that still use them. | |
1352 | |
1353 @defun x-get-cut-buffer n | |
1354 This function returns the contents of cut buffer number @var{n}. | |
1355 @end defun | |
1356 | |
26388 | 1357 @defun x-set-cut-buffer string &optional push |
6547 | 1358 This function stores @var{string} into the first cut buffer (cut buffer |
26388 | 1359 0). If @var{push} is @code{nil}, only the first cut buffer is changed. |
1360 If @var{push} is non-@code{nil}, that says to move the values down | |
1361 through the series of cut buffers, much like the way successive kills in | |
1362 Emacs move down the kill ring. In other words, the previous value of | |
1363 the first cut buffer moves into the second cut buffer, and the second to | |
1364 the third, and so on through all eight cut buffers. | |
6547 | 1365 @end defun |
1366 | |
22742
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1367 @defvar selection-coding-system |
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1368 This variable specifies the coding system to use when reading and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1369 writing selections, the clipboard, or a cut buffer. @xref{Coding |
26388 | 1370 Systems}. The default is @code{compound-text}, which converts to |
1371 the text representation that X11 normally uses. | |
22742
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1372 @end defvar |
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1373 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1374 @cindex clipboard support (for MS-Windows) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1375 When Emacs runs on MS-Windows, it does not implement X selections in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1376 general, but it it does support the clipboard. @code{x-get-selection} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1377 and @code{x-set-selection} on MS-Windows support the text data type |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1378 only; if the clipboard holds other types of data, Emacs treats the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1379 clipboard as empty. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1380 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1381 @defopt x-select-enable-clipboard |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1382 If this is non-@code{nil}, the Emacs yank functions consult the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1383 clipboard before the primary selection, and the kill functions store in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1384 the clipboard as well as the primary selection. Otherwise they do not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1385 access the clipboard at all. The default is @code{nil} on most systems, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1386 but @code{t} on MS-Windows. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1387 @end defopt |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1388 |
12098 | 1389 @node Color Names |
1390 @section Color Names | |
6547 | 1391 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1392 These functions provide a way to determine which color names are |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1393 valid, and what they look like. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1394 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1395 @defun color-defined-p color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1396 @tindex color-defined-p |
8712 | 1397 This function reports whether a color name is meaningful. It returns |
12676
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1398 @code{t} if so; otherwise, @code{nil}. The argument @var{frame} says |
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1399 which frame's display to ask about; if @var{frame} is omitted or |
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1400 @code{nil}, the selected frame is used. |
8712 | 1401 |
1402 Note that this does not tell you whether the display you are using | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1403 really supports that color. When using X, you can ask for any defined |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1404 color on any kind of display, and you will get some result---typically, |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1405 the closest it can do. To determine whether a frame can really display |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1406 a certain color, use @code{color-supported-p} (see below). |
8712 | 1407 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1408 @findex x-color-defined-p |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1409 This function used to be called @code{x-color-defined-p}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1410 and that name is still supported as an alias. |
8712 | 1411 @end defun |
6547 | 1412 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1413 @defun defined-colors &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1414 @tindex defined-colors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1415 This function returns a list of the color names that are defined |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1416 and supported on frame @var{frame} (default, the selected frame). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1417 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1418 @findex x-defined-colors |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1419 This function used to be called @code{x-defined-colors}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1420 and that name is still supported as an alias. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1421 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1422 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1423 @defun color-supported-p color &optional frame background-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1424 @tindex color-supported-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1425 This returns @code{t} if @var{frame} can really display the color |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1426 @var{color} (or at least something close to it). If @var{frame} is |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1427 omitted or @code{nil}, the question applies to the selected frame. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1428 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1429 Some terminals support a different set of colors for foreground and |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1430 background. If @var{background-p} is non-@code{nil}, that means you are |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1431 asking whether @var{color} can be used as a background; otherwise you |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1432 are asking whether it can be used as a foreground. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1433 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1434 The argument @var{color} must be a valid color name. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1435 @end defun |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1436 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1437 @defun color-gray-p color &optional frame |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1438 @tindex color-gray-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1439 This returns @code{t} if @var{color} is a shade of gray, as defined on |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1440 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, the |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1441 question applies to the selected frame. The argument @var{color} must |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1442 be a valid color name. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1443 @end defun |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1444 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1445 @defun color-values color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1446 @tindex color-values |
8712 | 1447 This function returns a value that describes what @var{color} should |
1448 ideally look like. If @var{color} is defined, the value is a list of | |
1449 three integers, which give the amount of red, the amount of green, and | |
1450 the amount of blue. Each integer ranges in principle from 0 to 65535, | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1451 but in practice no value seems to be above 65280. This kind |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1452 of three-element list is called an @dfn{rgb value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1453 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1454 If @var{color} is not defined, the value is @code{nil}. |
8712 | 1455 |
1456 @example | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1457 (color-values "black") |
8712 | 1458 @result{} (0 0 0) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1459 (color-values "white") |
8712 | 1460 @result{} (65280 65280 65280) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1461 (color-values "red") |
8712 | 1462 @result{} (65280 0 0) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1463 (color-values "pink") |
8712 | 1464 @result{} (65280 49152 51968) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1465 (color-values "hungry") |
8712 | 1466 @result{} nil |
1467 @end example | |
12676
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1468 |
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1469 The color values are returned for @var{frame}'s display. If @var{frame} |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1470 is omitted or @code{nil}, the information is returned for the selected |
12676
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1471 frame's display. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1472 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1473 @findex x-color-values |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1474 This function used to be called @code{x-color-values}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1475 and that name is still supported as an alias. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1476 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1477 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1478 @defun display-color-p &optional display |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1479 @tindex display-color-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1480 @findex x-display-color-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1481 This function returns @code{t} if the screen is a color screen. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1482 It used to be called @code{x-display-color-p}, and that name |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1483 is still supported as an alias. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1484 @end defun |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1485 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1486 @node Text Terminal Colors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1487 @section Text Terminal Colors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1488 @cindex colors on text-only terminals |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1489 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1490 Emacs can display color on text-only terminals, starting with version |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1491 21. These terminals support only a small number of colors, and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1492 computer uses small integers to select colors on the terminal. This |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1493 means that the computer cannot reliably tell what the selected color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1494 looks like; instead, you have to inform your application which small |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1495 integers correspond to which colors. However, Emacs does know the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1496 standard set of colors and will try to use them automatically. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1497 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1498 @cindex rgb value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1499 Several of these functions use or return @dfn{rgb values}. An rgb |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1500 value is a list of three integers, which give the amount of red, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1501 amount of green, and the amount of blue. Each integer ranges in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1502 principle from 0 to 65535, but in practice the largest value used is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1503 65280. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1504 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1505 These functions accept a frame as an optional argument. We hope in |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1506 the future to make Emacs support multiple text-only terminals; then |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1507 this'argument will specify which terminal to operate on (the default |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1508 being the selected frame). At present, though, the @var{frame} argument |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1509 has no effect. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1510 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1511 @defun tty-color-define name number &optional rgb frame |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1512 @tindex tty-color-define |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1513 This function associates the color name @var{name} with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1514 color number @var{number} on the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1515 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1516 The optional argument @var{rgb}, if specified, is an rgb value; it says |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1517 what the color actually looks like. If you do not specify @var{rgb}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1518 then this color cannot be used by @code{tty-color-approximate} to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1519 approximate other colors, because Emacs does not know what it looks |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1520 like. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1521 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1522 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1523 @defun tty-color-clear &optional frame |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1524 @tindex tty-color-clear |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1525 This function clears the table of defined colors for a text-only terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1526 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1527 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1528 @defun tty-color-alist &optional frame |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1529 @tindex tty-color-alist |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1530 This function returns an alist recording the known colors supported by a |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1531 text-only terminal. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1532 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1533 Each element has the form @code{(@var{name} @var{number} . @var{rgb})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1534 or @code{(@var{name} @var{number})}. Here, @var{name} is the color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1535 name, @var{number} is the number used to specify it to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1536 If present, @var{rgb} is an rgb value that says what the color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1537 actually looks like. |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1538 @end defun |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1539 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1540 @defun tty-color-approximate rgb &optional frame |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1541 @tindex tty-color-approximate |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1542 This function finds the closest color, among the known colors supported |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1543 for @var{frame}'s terminal, to that described by the rgb value |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1544 @var{rgb}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1545 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1546 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1547 @defun tty-color-translate color &optional frame |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1548 @tindex tty-color-translate |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1549 This function finds the closest color to @var{color} among the known |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1550 colors supported for @var{frame}'s terminal. If the name @var{color} is |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1551 not defined, the value is @code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1552 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1553 @var{color} can be an X-style @code{"#@var{xxxyyyzzz}"} specification |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1554 instead of an actual name. The format |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1555 @code{"RGB:@var{xx}/@var{yy}/@var{zz}"} is also supported. |
6547 | 1556 @end defun |
1557 | |
1558 @node Resources | |
1559 @section X Resources | |
1560 | |
12098 | 1561 @defun x-get-resource attribute class &optional component subclass |
6547 | 1562 The function @code{x-get-resource} retrieves a resource value from the X |
1563 Windows defaults database. | |
1564 | |
1565 Resources are indexed by a combination of a @dfn{key} and a @dfn{class}. | |
1566 This function searches using a key of the form | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1567 @samp{@var{instance}.@var{attribute}} (where @var{instance} is the name |
12098 | 1568 under which Emacs was invoked), and using @samp{Emacs.@var{class}} as |
1569 the class. | |
6547 | 1570 |
1571 The optional arguments @var{component} and @var{subclass} add to the key | |
1572 and the class, respectively. You must specify both of them or neither. | |
1573 If you specify them, the key is | |
1574 @samp{@var{instance}.@var{component}.@var{attribute}}, and the class is | |
12098 | 1575 @samp{Emacs.@var{class}.@var{subclass}}. |
6547 | 1576 @end defun |
1577 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1578 @defvar x-resource-class |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1579 This variable specifies the application name that @code{x-get-resource} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1580 should look up. The default value is @code{"Emacs"}. You can examine X |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1581 resources for application names other than ``Emacs'' by binding this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1582 variable to some other string, around a call to @code{x-get-resource}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1583 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1584 |
12098 | 1585 @xref{Resources X,, X Resources, emacs, The GNU Emacs Manual}. |
6547 | 1586 |
1587 @node Server Data | |
1588 @section Data about the X Server | |
1589 | |
13155
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1590 This section describes functions you can use to get information about |
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1591 the capabilities and origin of an X display that Emacs is using. Each |
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1592 of these functions lets you specify the display you are interested in: |
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1593 the @var{display} argument can be either a display name, or a frame |
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1594 (meaning use the display that frame is on). If you omit the |
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1595 @var{display} argument, or specify @code{nil}, that means to use the |
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
1596 selected frame's display. |
6547 | 1597 |
12067 | 1598 @defun x-display-screens &optional display |
1599 This function returns the number of screens associated with the display. | |
6547 | 1600 @end defun |
1601 | |
12067 | 1602 @defun x-server-version &optional display |
1603 This function returns the list of version numbers of the X server | |
1604 running the display. | |
6547 | 1605 @end defun |
1606 | |
12067 | 1607 @defun x-server-vendor &optional display |
1608 This function returns the vendor that provided the X server software. | |
6547 | 1609 @end defun |
1610 | |
12067 | 1611 @defun x-display-pixel-height &optional display |
1612 This function returns the height of the screen in pixels. | |
6547 | 1613 @end defun |
1614 | |
12067 | 1615 @defun x-display-mm-height &optional display |
1616 This function returns the height of the screen in millimeters. | |
6547 | 1617 @end defun |
1618 | |
12067 | 1619 @defun x-display-pixel-width &optional display |
1620 This function returns the width of the screen in pixels. | |
6547 | 1621 @end defun |
1622 | |
12067 | 1623 @defun x-display-mm-width &optional display |
1624 This function returns the width of the screen in millimeters. | |
1625 @end defun | |
1626 | |
1627 @defun x-display-backing-store &optional display | |
1628 This function returns the backing store capability of the screen. | |
6547 | 1629 Values can be the symbols @code{always}, @code{when-mapped}, or |
1630 @code{not-useful}. | |
1631 @end defun | |
1632 | |
12067 | 1633 @defun x-display-save-under &optional display |
1634 This function returns non-@code{nil} if the display supports the | |
6547 | 1635 SaveUnder feature. |
1636 @end defun | |
1637 | |
12067 | 1638 @defun x-display-planes &optional display |
1639 This function returns the number of planes the display supports. | |
6547 | 1640 @end defun |
1641 | |
12067 | 1642 @defun x-display-visual-class &optional display |
1643 This function returns the visual class for the screen. The value is one | |
1644 of the symbols @code{static-gray}, @code{gray-scale}, | |
6547 | 1645 @code{static-color}, @code{pseudo-color}, @code{true-color}, and |
1646 @code{direct-color}. | |
1647 @end defun | |
1648 | |
12067 | 1649 @defun x-display-grayscale-p &optional display |
1650 This function returns @code{t} if the screen can display shades of gray. | |
6547 | 1651 @end defun |
1652 | |
12067 | 1653 @defun x-display-color-cells &optional display |
1654 This function returns the number of color cells the screen supports. | |
6547 | 1655 @end defun |
1656 | |
1657 @ignore | |
1658 @defvar x-no-window-manager | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1659 This variable's value is @code{t} if no X window manager is in use. |
6547 | 1660 @end defvar |
1661 @end ignore | |
1662 | |
1663 @ignore | |
1664 @item | |
1665 The functions @code{x-pixel-width} and @code{x-pixel-height} return the | |
1666 width and height of an X Window frame, measured in pixels. | |
1667 @end ignore |