Mercurial > emacs
annotate lispref/frames.texi @ 10128:59ccd063e016
(search_regs_saved): Delete initializer.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 07 Dec 1994 13:03:48 +0000 |
parents | 67b759a9096d |
children | 126f7560fd28 |
rev | line source |
---|---|
6547 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
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 | |
10 A @var{frame} is a rectangle on the screen that contains one or more | |
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 | |
16 @cindex X window frame | |
17 When Emacs runs on a text-only terminal, it has just one frame, a | |
18 @dfn{terminal frame}. There is no way to create another terminal frame | |
19 after startup. If Emacs has an X display, it does not have a terminal | |
20 frame; instead, it starts with a single @dfn{X window frame}. You can | |
21 create more; see @ref{Creating Frames}. | |
22 | |
23 @defun framep object | |
24 This predicate returns @code{t} if @var{object} is a frame, and | |
25 @code{nil} otherwise. | |
26 @end defun | |
27 | |
28 @menu | |
29 * Creating Frames:: Creating additional X Window frames. | |
30 * Frame Parameters:: Controlling frame size, position, font, etc. | |
31 * Deleting Frames:: Frames last until explicitly deleted. | |
32 * Finding All Frames:: How to examine all existing frames. | |
33 * Frames and Windows:: A frame contains windows; | |
34 display of text always works through windows. | |
35 * Minibuffers and Frames:: How a frame finds the minibuffer to use. | |
36 * Input Focus:: Specifying the selected frame. | |
37 * Visibility of Frames:: Frames may be visible or invisible, or icons. | |
38 * Raising and Lowering:: Raising a frame makes it hide other X windows; | |
39 lowering it makes the others hide them. | |
40 * Frame Configurations:: Saving the state of all frames. | |
41 * Mouse Tracking:: Getting events that say when the mouse moves. | |
42 * Mouse Position:: Asking where the mouse is, or moving it. | |
43 * Pop-Up Menus:: Displaying a menu for the user to select from. | |
44 * 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
|
45 * Pointer Shapes:: Specifying the shape of the mouse pointer. |
6547 | 46 * X Selections:: Transferring text to and from other X clients. |
47 * X Connections:: Opening and closing the X server connection. | |
48 * Resources:: Getting resource values from the server. | |
49 * Server Data:: Getting info about the X server. | |
50 @end menu | |
51 | |
52 @xref{Display}, for related information. | |
53 | |
54 @node Creating Frames | |
55 @section Creating Frames | |
56 | |
57 To create a new frame, call the function @code{make-frame}. | |
58 | |
59 @defun make-frame alist | |
60 This function creates a new frame, if the display mechanism permits | |
61 creation of frames. (An X server does; an ordinary terminal does not.) | |
62 | |
63 The argument is an alist specifying frame parameters. Any parameters | |
64 not mentioned in @var{alist} default according to the value of the | |
65 variable @code{default-frame-alist}; parameters not specified there | |
66 either default from the standard X defaults file and X resources. | |
67 | |
68 The set of possible parameters depends in principle on what kind of | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
69 window system Emacs uses to display its frames. @xref{X Frame |
6547 | 70 Parameters}, for documentation of individual parameters you can specify |
71 when creating an X window frame. | |
72 @end defun | |
73 | |
74 @defvar before-make-frame-hook | |
75 A normal hook run by @code{make-frame} before it actually creates the | |
76 frame. | |
77 @end defvar | |
78 | |
79 @defvar after-make-frame-hook | |
80 A normal hook run by @code{make-frame} after it creates the frame. | |
81 @end defvar | |
82 | |
83 @node Frame Parameters | |
84 @section Frame Parameters | |
85 | |
86 A frame has many parameters that control its appearance and behavior. | |
87 Just what parameters a frame has depends on what display mechanism it | |
88 uses. | |
89 | |
90 Frame parameters exist for the sake of window systems. A terminal frame | |
91 has a few parameters, for compatibility's sake only. You can't change | |
92 these parameters directly; the only ones that ever change are the height | |
93 and width. | |
94 | |
95 @menu | |
96 * Parameter Access:: How to change a frame's parameters. | |
97 * Initial Parameters:: Specifying frame parameters when you make a frame. | |
98 * X Frame Parameters:: Individual parameters documented. | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
99 * Size and Position:: Changing the size and position of a frame. |
6547 | 100 @end menu |
101 | |
102 @node Parameter Access | |
103 @subsection Access to Frame Parameters | |
104 | |
105 These functions let you read and change the parameter values of a | |
106 frame. | |
107 | |
108 @defun frame-parameters frame | |
109 The function @code{frame-parameters} returns an alist listing all the | |
110 parameters of @var{frame} and their values. | |
111 @end defun | |
112 | |
113 @defun modify-frame-parameters frame alist | |
114 This function alters the parameters of frame @var{frame} based on the | |
115 elements of @var{alist}. Each element of @var{alist} has the form | |
116 @code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a | |
117 parameter. If you don't mention a parameter in @var{alist}, its value | |
118 doesn't change. | |
119 @end defun | |
120 | |
121 @node Initial Parameters | |
122 @subsection Initial Frame Parameters | |
123 | |
124 You can specify the parameters for the initial startup frame | |
125 by setting @code{initial-frame-alist} in your @file{.emacs} file. | |
126 | |
127 @defvar initial-frame-alist | |
128 This variable's value is an alist of parameter values used when creating | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
129 the initial X window frame. Each element has the form: |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
130 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
131 @example |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
132 (@var{parameter} . @var{value}) |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
133 @end example |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
134 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
135 Emacs creates the initial frame before it reads your @file{~/.emacs} |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
136 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
|
137 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
|
138 created initial frame. |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
139 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
140 If these settings affect the frame geometry, you'll see the frame appear |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
141 with the wrong geometry and then change to the specified one. If you |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
142 like, you can specify the same geometry with X resources; those do take |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
143 affect before the frame is created. @xref{Resources X,, X Resources, |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
144 emacs, The GNU Emacs Manual}. |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
145 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
146 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
|
147 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
|
148 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
|
149 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
|
150 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
|
151 the initial frame, specify the same parameters in |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
152 @code{initial-frame-alist} with values that match the X resources. |
6547 | 153 @end defvar |
154 | |
155 If these parameters specify a separate minibuffer-only frame, | |
156 and you have not created one, Emacs creates one for you. | |
157 | |
158 @defvar minibuffer-frame-alist | |
159 This variable's value is an alist of parameter values used when creating | |
160 an initial minibuffer-only frame---if such a frame is needed, according | |
161 to the parameters for the main initial frame. | |
162 @end defvar | |
163 | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
164 @defvar special-display-frame-alist |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
165 The variable @code{special-display-frame-alist} specifies the frame |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
166 parameters for special display frames. |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
167 @end defvar |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
168 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
169 @defvar default-frame-alist |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
170 This is an alist specifying default values of frame parameters for |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
171 subsequent Emacs frames (not the initial ones). |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
172 @end defvar |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
173 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
174 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
|
175 they take effect by adding elements to @code{default-frame-alist}. One |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
176 exception is @samp{-geometry}, which adds to @code{initial-frame-alist} |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
177 instead. @xref{Command Arguments,,, emacs, The GNU Emacs Manual}. |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
178 |
6547 | 179 @node X Frame Parameters |
180 @subsection X Window Frame Parameters | |
181 | |
182 Just what parameters a frame has depends on what display mechanism it | |
183 uses. Here is a table of the parameters of an X window frame: | |
184 | |
185 @table @code | |
186 @item name | |
187 The name of the frame. Most window managers display the frame's name in | |
188 the frame's border, at the top of the frame. If you don't specify a | |
189 name, and you have more than one frame, Emacs sets the frame name based | |
190 on the buffer displayed in the frame's selected window. | |
191 | |
192 If you specify the frame name explicitly when you create the frame, the | |
193 name is also used (instead of the name of the Emacs executable) when | |
194 looking up X resources for the frame. | |
195 | |
196 @item left | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
197 The screen position of the left edge, in pixels. The value may be |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
198 @code{-} instead of a number; that represents @samp{-0} in a geometry |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
199 specification. |
6547 | 200 |
201 @item top | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
202 The screen position of the top edge, in pixels. The value may be |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
203 @code{-} instead of a number; that represents @samp{-0} in a geometry |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
204 specification. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
205 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
206 @item user-position |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
207 Non-@code{nil} if the screen position of the frame was explicitly |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
208 requested by the user (for example, with the @samp{-geometry} option). |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
209 Nothing automatically makes this parameter non-@code{nil}; it is up to |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
210 Lisp programs that call @code{make-frame} to specify this parameter as |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
211 well as specifying the @code{left} and @code{top} parameters. |
6547 | 212 |
213 @item height | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
214 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
|
215 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) |
6547 | 216 |
217 @item width | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
218 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
|
219 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) |
6547 | 220 |
221 @item window-id | |
222 The number of the X window for the frame. | |
223 | |
224 @item minibuffer | |
225 Whether this frame has its own minibuffer. The value @code{t} means | |
226 yes, @code{nil} means no, @code{only} means this frame is just a | |
227 minibuffer, a minibuffer window (in some other frame) means the new | |
228 frame uses that minibuffer. | |
229 | |
230 @item font | |
231 The name of the font for displaying text in the frame. This is a | |
232 string. | |
233 | |
234 @item auto-raise | |
235 Whether selecting the frame raises it (non-@code{nil} means yes). | |
236 | |
237 @item auto-lower | |
238 Whether deselecting the frame lowers it (non-@code{nil} means yes). | |
239 | |
240 @item vertical-scroll-bars | |
241 Whether the frame has scroll bars for vertical scrolling | |
242 (non-@code{nil} means yes). | |
243 | |
244 @item horizontal-scroll-bars | |
245 Whether the frame has scroll bars for horizontal scrolling | |
246 (non-@code{nil} means yes). (Horizontal scroll bars are not currently | |
247 implemented.) | |
248 | |
249 @item icon-type | |
250 The type of icon to use for this frame when it is iconified. | |
251 Non-@code{nil} specifies a bitmap icon, @code{nil} a text icon. | |
252 | |
253 @item foreground-color | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
254 The color to use for the image of a character. This is a string; the X |
6547 | 255 server defines the meaningful color names. |
256 | |
257 @item background-color | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
258 The color to use for the background of characters. |
6547 | 259 |
260 @item mouse-color | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
261 The color for the mouse pointer. |
6547 | 262 |
263 @item cursor-color | |
264 The color for the cursor that shows point. | |
265 | |
266 @item border-color | |
267 The color for the border of the frame. | |
268 | |
269 @item cursor-type | |
270 The way to display the cursor. There are two legitimate values: | |
271 @code{bar} and @code{box}. The symbol @code{bar} specifies a vertical | |
272 bar between characters as the cursor. The symbol @code{box} specifies | |
273 an ordinary black box overlaying the character after point; that is the | |
274 default. | |
275 | |
276 @item border-width | |
277 The width in pixels of the window border. | |
278 | |
279 @item internal-border-width | |
280 The distance in pixels between text and border. | |
281 | |
282 @item unsplittable | |
283 If non-@code{nil}, this frame's window is never split automatically. | |
284 | |
285 @item visibility | |
286 The state of visibility of the frame. There are three possibilities: | |
287 @code{nil} for invisible, @code{t} for visible, and @code{icon} for | |
288 iconified. @xref{Visibility of Frames}. | |
289 | |
290 @item menu-bar-lines | |
291 The number of lines to allocate at the top of the frame for a menu bar. | |
9453 | 292 The default is 1. @xref{Menu Bar}. (In Emacs versions that use the X |
293 toolkit, there is only one menu bar line; all that matters about the | |
294 number you specify is whether it is greater than zero.) | |
6547 | 295 |
296 @item parent-id | |
297 @c ??? Not yet working. | |
298 The X window number of the window that should be the parent of this one. | |
299 Specifying this lets you create an Emacs window inside some other | |
300 application's window. (It is not certain this will be implemented; try | |
301 it and see if it works.) | |
302 @end table | |
303 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
304 @node Size and Position |
6547 | 305 @subsection Frame Size And Position |
306 | |
307 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
|
308 frame parameters @code{left}, @code{top}, @code{height}, and |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
309 @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
|
310 by the window manager in its usual fashion. |
6547 | 311 |
312 Here are some special features for working with sizes and positions: | |
313 | |
314 @defun set-frame-position frame left top | |
315 This function sets the position of the top left corner of | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
316 @var{frame} to @var{left} and @var{top}. These arguments are measured |
6547 | 317 in pixels, counting from the top left corner of the screen. |
318 @end defun | |
319 | |
320 @defun frame-height &optional frame | |
321 @defunx frame-width &optional frame | |
322 These functions return the height and width of @var{frame}, measured in | |
323 characters. If you don't supply @var{frame}, they use the selected | |
324 frame. | |
325 @end defun | |
326 | |
327 @defun frame-pixel-height &optional frame | |
328 @defunx frame-pixel-width &optional frame | |
329 These functions return the height and width of @var{frame}, measured in | |
330 pixels. If you don't supply @var{frame}, they use the selected frame. | |
331 @end defun | |
332 | |
333 @defun frame-char-height &optional frame | |
334 @defunx frame-char-width &optional frame | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
335 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
|
336 @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
|
337 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
|
338 frame. |
6547 | 339 @end defun |
340 | |
341 @defun set-frame-size frame cols rows | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
342 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
|
343 @var{cols} and @var{rows} specify the new width and height. |
6547 | 344 |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
345 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
|
346 @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
|
347 them to units of characters. |
6547 | 348 @end defun |
349 | |
350 The old-fashioned functions @code{set-screen-height} and | |
351 @code{set-screen-width}, which were used to specify the height and width | |
352 of the screen in Emacs versions that did not support multiple frames, | |
353 are still usable. They apply to the selected frame. @xref{Screen | |
354 Size}. | |
355 | |
356 @defun x-parse-geometry geom | |
357 @cindex geometry specification | |
358 The function @code{x-parse-geometry} converts a standard X windows | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
359 geometry string to an alist that you can use as part of the argument to |
6547 | 360 @code{make-frame}. |
361 | |
362 The alist describes which parameters were specified in @var{geom}, and | |
363 gives the values specified for them. Each element looks like | |
364 @code{(@var{parameter} . @var{value})}. The possible @var{parameter} | |
365 values are @code{left}, @code{top}, @code{width}, and @code{height}. | |
366 | |
367 @smallexample | |
368 (x-parse-geometry "35x70+0-0") | |
369 @result{} ((width . 35) (height . 70) (left . 0) (top . -1)) | |
370 @end smallexample | |
371 @end defun | |
372 | |
373 @ignore | |
374 New functions @code{set-frame-height} and @code{set-frame-width} set the | |
375 size of a specified frame. The frame is the first argument; the size is | |
376 the second. | |
377 @end ignore | |
378 | |
379 @node Deleting Frames | |
380 @section Deleting Frames | |
381 @cindex deletion of frames | |
382 | |
383 Frames remain potentially visible until you explicitly @dfn{delete} | |
384 them. A deleted frame cannot appear on the screen, but continues to | |
385 exist as a Lisp object until there are no references to it. There is no | |
386 way to cancel the deletion of a frame aside from restoring a saved frame | |
387 configuration (@pxref{Frame Configurations}); this is similar to the | |
388 way windows behave. | |
389 | |
390 @deffn Command delete-frame &optional frame | |
391 This function deletes the frame @var{frame}. By default, @var{frame} is | |
392 the selected frame. | |
393 @end deffn | |
394 | |
395 @defun frame-live-p frame | |
396 The function @code{frame-live-p} returns non-@code{nil} if the frame | |
397 @var{frame} has not been deleted. | |
398 @end defun | |
399 | |
400 @node Finding All Frames | |
401 @section Finding All Frames | |
402 | |
403 @defun frame-list | |
404 The function @code{frame-list} returns a list of all the frames that | |
405 have not been deleted. It is analogous to @code{buffer-list} for | |
406 buffers. The list that you get is newly created, so modifying the list | |
407 doesn't have any effect on the internals of Emacs. | |
408 @end defun | |
409 | |
410 @defun visible-frame-list | |
411 This function returns a list of just the currently visible frames. | |
412 @xref{Visibility of Frames}. | |
413 @end defun | |
414 | |
415 @defun next-frame &optional frame minibuf | |
416 The function @code{next-frame} lets you cycle conveniently through all | |
417 the frames from an arbitrary starting point. It returns the ``next'' | |
418 frame after @var{frame} in the cycle. If @var{frame} is omitted or | |
419 @code{nil}, it defaults to the selected frame. | |
420 | |
421 The second argument, @var{minibuf}, says which frames to consider: | |
422 | |
423 @table @asis | |
424 @item @code{nil} | |
425 Exclude minibuffer-only frames. | |
426 @item @code{visible} | |
427 Consider all visible frames. | |
428 @item a window | |
429 Consider only the frames using that particular window as their | |
430 minibuffer. | |
431 @item anything else | |
432 Consider all frames. | |
433 @end table | |
434 @end defun | |
435 | |
436 @defun previous-frame &optional frame minibuf | |
437 Like @code{next-frame}, but cycles through all frames in the opposite | |
438 direction. | |
439 @end defun | |
440 | |
441 @node Frames and Windows | |
442 @section Frames and Windows | |
443 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
444 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
|
445 with @code{window-frame}. |
6547 | 446 |
447 @defun window-frame window | |
448 This function returns the frame that @var{window} is on. | |
449 @end defun | |
450 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
451 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
|
452 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
|
453 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
|
454 the lower right corner (always the minibuffer window, if the frame has |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
455 one), and then it moves back to the top. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
456 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
457 @defun frame-top-window frame |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
458 This returns the topmost, leftmost window of frame @var{frame}. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
459 @end defun |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
460 |
6547 | 461 At any time, exactly one window on any frame is @dfn{selected within the |
462 frame}. The significance of this designation is that selecting the | |
463 frame also selects this window. You can get the frame's current | |
464 selected window with @code{frame-selected-window}. | |
465 | |
466 @defun frame-selected-window frame | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
467 This function returns the window on @var{frame} that is selected within |
6547 | 468 @var{frame}. |
469 @end defun | |
470 | |
471 Conversely, selecting a window for Emacs with @code{select-window} also | |
472 makes that window selected within its frame. @xref{Selecting Windows}. | |
473 | |
474 @node Minibuffers and Frames | |
475 @section Minibuffers and Frames | |
476 | |
477 Normally, each frame has its own minibuffer window at the bottom, which | |
478 is used whenever that frame is selected. If the frame has a minibuffer, | |
479 you can get it with @code{minibuffer-window} (@pxref{Minibuffer Misc}). | |
480 | |
481 However, you can also create a frame with no minibuffer. Such a frame | |
482 must use the minibuffer window of some other frame. When you create the | |
483 frame, you can specify explicitly the frame on which to find the | |
484 minibuffer to use. If you don't, then the minibuffer is found in the | |
485 frame which is the value of the variable | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
486 @code{default-minibuffer-frame}. Its value should be a frame that does |
6547 | 487 have a minibuffer. |
488 | |
489 If you use a minibuffer-only frame, you might want that frame to raise | |
490 when you enter the minibuffer. If so, set the variable | |
491 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}. | |
492 | |
493 @node Input Focus | |
494 @section Input Focus | |
495 @cindex input focus | |
496 @cindex selected frame | |
497 | |
498 At any time, one frame in Emacs is the @dfn{selected frame}. The selected | |
499 window always resides on the selected frame. | |
500 | |
501 @defun selected-frame | |
502 This function returns the selected frame. | |
503 @end defun | |
504 | |
505 The X server normally directs keyboard input to the X window that the | |
506 mouse is in. Some window managers use mouse clicks or keyboard events | |
507 to @dfn{shift the focus} to various X windows, overriding the normal | |
508 behavior of the server. | |
509 | |
510 Lisp programs can switch frames ``temporarily'' by calling | |
511 the function @code{select-frame}. This does not override the window | |
512 manager; rather, it escapes from the window manager's control until | |
513 that control is somehow reasserted. | |
514 | |
515 @c ??? This is not yet implemented properly. | |
516 @defun select-frame frame | |
517 This function selects frame @var{frame}, temporarily disregarding the | |
518 focus of the X server. The selection of @var{frame} lasts until the | |
519 next time the user does something to select a different frame, or until | |
520 the next time this function is called. | |
521 @end defun | |
522 | |
523 Emacs cooperates with the X server and the window managers by arranging | |
524 to select frames according to what the server and window manager ask | |
525 for. It does so by generating a special kind of input event, called a | |
526 @dfn{focus} event. The command loop handles a focus event by calling | |
527 @code{handle-select-frame}. @xref{Focus Events}. | |
528 | |
529 @deffn Command handle-switch-frame frame | |
530 This function handles a focus event by selecting frame @var{frame}. | |
531 | |
532 Focus events normally do their job by invoking this command. | |
533 Don't call it for any other reason. | |
534 @end deffn | |
535 | |
536 @defun redirect-frame-focus frame focus-frame | |
537 This function redirects focus from @var{frame} to @var{focus-frame}. | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
538 This means that @var{focus-frame} will receive subsequent keystrokes |
6547 | 539 intended for @var{frame}. After such an event, the value of |
540 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame | |
541 events specifying @var{frame} will instead select @var{focus-frame}. | |
542 | |
543 If @var{focus-frame} is @code{nil}, that cancels any existing | |
544 redirection for @var{frame}, which therefore once again receives its own | |
545 events. | |
546 | |
547 One use of focus redirection is for frames that don't have minibuffers. | |
548 These frames use minibuffers on other frames. Activating a minibuffer | |
549 on another frame redirects focus to that frame. This puts the focus on | |
550 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
|
551 in the frame that activated the minibuffer. |
6547 | 552 |
553 Selecting a frame can also change focus redirections. Selecting frame | |
554 @code{bar}, when @code{foo} had been selected, changes any redirections | |
555 pointing to @code{foo} so that they point to @code{bar} instead. This | |
556 allows focus redirection to work properly when the user switches from | |
557 one frame to another using @code{select-window}. | |
558 | |
559 This means that a frame whose focus is redirected to itself is treated | |
560 differently from a frame whose focus is not redirected. | |
561 @code{select-frame} affects the former but not the latter. | |
562 | |
563 The redirection lasts until @code{redirect-frame-focus} is called to | |
564 change it. | |
565 @end defun | |
566 | |
567 @node Visibility of Frames | |
568 @section Visibility of Frames | |
569 @cindex visible frame | |
570 @cindex invisible frame | |
571 @cindex iconified frame | |
572 @cindex frame visibility | |
573 | |
574 A frame may be @dfn{visible}, @dfn{invisible}, or @dfn{iconified}. If | |
575 it is visible, you can see its contents. If it is iconified, the | |
576 frame's contents do not appear on the screen, but an icon does. If the | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
577 frame is invisible, it doesn't show on the screen, not even as an icon. |
6547 | 578 |
579 @deffn Command make-frame-visible &optional frame | |
580 This function makes frame @var{frame} visible. If you omit @var{frame}, | |
581 it makes the selected frame visible. | |
582 @end deffn | |
583 | |
584 @deffn Command make-frame-invisible &optional frame | |
585 This function makes frame @var{frame} invisible. If you omit | |
586 @var{frame}, it makes the selected frame invisible. | |
587 @end deffn | |
588 | |
589 @deffn Command iconify-frame &optional frame | |
590 This function iconifies frame @var{frame}. If you omit @var{frame}, it | |
591 iconifies the selected frame. | |
592 @end deffn | |
593 | |
594 @defun frame-visible-p frame | |
595 This returns the visibility status of frame @var{frame}. The value is | |
596 @code{t} if @var{frame} is visible, @code{nil} if it is invisible, and | |
597 @code{icon} if it is iconified. | |
598 @end defun | |
599 | |
600 The visibility status of a frame is also available as a frame | |
601 parameter. You can read or change it as such. @xref{X Frame | |
602 Parameters}. | |
603 | |
604 @node Raising and Lowering | |
605 @section Raising and Lowering Frames | |
606 | |
607 The X Window System uses a desktop metaphor. Part of this metaphor is | |
608 the idea that windows are stacked in a notional third dimension | |
609 perpendicular to the screen surface, and thus ordered from ``highest'' | |
610 to ``lowest''. Where two windows overlap, the one higher up covers the | |
611 one underneath. Even a window at the bottom of the stack can be seen if | |
612 no other window overlaps it. | |
613 | |
614 @cindex raising a frame | |
615 @cindex lowering a frame | |
616 A window's place in this ordering is not fixed; in fact, users tend to | |
617 change the order frequently. @dfn{Raising} a window means moving it | |
618 ``up'', to the top of the stack. @dfn{Lowering} a window means moving | |
619 it to the bottom of the stack. This motion is in the notional third | |
620 dimension only, and does not change the position of the window on the | |
621 screen. | |
622 | |
623 You can raise and lower Emacs's X windows with these functions: | |
624 | |
625 @defun raise-frame frame | |
626 This function raises frame @var{frame}. | |
627 @end defun | |
628 | |
629 @defun lower-frame frame | |
630 This function lowers frame @var{frame}. | |
631 @end defun | |
632 | |
633 @defopt minibuffer-auto-raise | |
634 If this is non-@code{nil}, activation of the minibuffer raises the frame | |
635 that the minibuffer window is in. | |
636 @end defopt | |
637 | |
638 You can also enable auto-raise (raising automatically when a frame is | |
639 selected) or auto-lower (lowering automatically when it is deselected) | |
640 for any frame using frame parameters. @xref{X Frame Parameters}. | |
641 | |
642 @node Frame Configurations | |
643 @section Frame Configurations | |
644 @cindex frame configuration | |
645 | |
646 A @dfn{frame configuration} records the current arrangement of frames, | |
647 all their properties, and the window configuration of each one. | |
648 | |
649 @defun current-frame-configuration | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
650 This function returns a frame configuration list that describes |
6547 | 651 the current arrangement of frames and their contents. |
652 @end defun | |
653 | |
654 @defun set-frame-configuration configuration | |
655 This function restores the state of frames described in | |
656 @var{configuration}. | |
657 @end defun | |
658 | |
659 @node Mouse Tracking | |
660 @section Mouse Tracking | |
661 @cindex mouse tracking | |
662 @cindex tracking the mouse | |
663 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
664 Sometimes it is useful to @dfn{track} the mouse, which means to display |
6547 | 665 something to indicate where the mouse is and move the indicator as the |
666 mouse moves. For efficient mouse tracking, you need a way to wait until | |
667 the mouse actually moves. | |
668 | |
669 The convenient way to track the mouse is to ask for events to represent | |
670 mouse motion. Then you can wait for motion by waiting for an event. In | |
671 addition, you can easily handle any other sorts of events that may | |
672 occur. That is useful, because normally you don't want to track the | |
673 mouse forever---only until some other event, such as the release of a | |
674 button. | |
675 | |
676 @defspec track-mouse body@dots{} | |
677 Execute @var{body}, meanwhile generating input events for mouse motion. | |
678 The code in @var{body} can read these events with @code{read-event} or | |
679 @code{read-key-sequence}. @xref{Motion Events}, for the format of mouse | |
680 motion events. | |
681 | |
682 The value of @code{track-mouse} is that of the last form in @var{body}. | |
683 @end defspec | |
684 | |
685 The usual purpose of tracking mouse motion is to indicate on the screen | |
686 the consequences of pushing or releasing a button at the current | |
687 position. | |
688 | |
689 @ignore | |
690 @c These are not implemented yet. | |
691 | |
692 These functions change the screen appearance instantaneously. The | |
693 effect is transient, only until the next ordinary Emacs redisplay. That | |
694 is ok for mouse tracking, since it doesn't make sense for mouse tracking | |
695 to change the text, and the body of @code{track-mouse} normally reads | |
696 the events itself and does not do redisplay. | |
697 | |
698 @defun x-contour-region window beg end | |
699 This function draws lines to make a box around the text from @var{beg} | |
700 to @var{end}, in window @var{window}. | |
701 @end defun | |
702 | |
703 @defun x-uncontour-region window beg end | |
704 This function erases the lines that would make a box around the text | |
705 from @var{beg} to @var{end}, in window @var{window}. Use it to remove | |
706 a contour that you previously made by calling @code{x-contour-region}. | |
707 @end defun | |
708 | |
709 @defun x-draw-rectangle frame left top right bottom | |
710 This function draws a hollow rectangle on frame @var{frame} with the | |
711 specified edge coordinates, all measured in pixels from the inside top | |
712 left corner. It uses the cursor color, the one used for indicating the | |
713 location of point. | |
714 @end defun | |
715 | |
716 @defun x-erase-rectangle frame left top right bottom | |
717 This function erases a hollow rectangle on frame @var{frame} with the | |
718 specified edge coordinates, all measured in pixels from the inside top | |
719 left corner. Erasure means redrawing the text and background that | |
720 normally belong in the specified rectangle. | |
721 @end defun | |
722 @end ignore | |
723 | |
724 @node Mouse Position | |
725 @section Mouse Position | |
726 @cindex mouse position | |
727 @cindex position of mouse | |
728 | |
729 The functions @code{mouse-position} and @code{set-mouse-position} | |
730 give access to the current position of the mouse. | |
731 | |
732 @defun mouse-position | |
733 This function returns a description of the position of the mouse. The | |
734 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
|
735 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
|
736 the top left corner of the inside of @var{frame}. |
6547 | 737 @end defun |
738 | |
739 @defun set-mouse-position frame x y | |
740 This function @dfn{warps the mouse} to position @var{x}, @var{y} in | |
741 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
|
742 giving the position in characters relative to the top left corner of the |
6547 | 743 inside of @var{frame}. |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
744 @end defun |
6547 | 745 |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
746 @defun mouse-pixel-position |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
747 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
|
748 coordinates in units of pixels rather than units of characters. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
749 @end defun |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
750 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
751 @defun set-mouse-pixel-position frame x y |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
752 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
|
753 @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
|
754 characters. These coordinates are not required to be within the frame. |
6547 | 755 @end defun |
756 | |
757 @need 3000 | |
758 | |
759 @node Pop-Up Menus | |
760 @section Pop-Up Menus | |
761 | |
762 @defun x-popup-menu position menu | |
763 This function displays a pop-up menu and returns an indication of | |
764 what selection the user makes. | |
765 | |
766 The argument @var{position} specifies where on the screen to put the | |
767 menu. It can be either a mouse button event (which says to put the menu | |
768 where the user actuated the button) or a list of this form: | |
769 | |
770 @example | |
771 ((@var{xoffset} @var{yoffset}) @var{window}) | |
772 @end example | |
773 | |
774 @noindent | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
775 where @var{xoffset} and @var{yoffset} are coordinates, measured in |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
776 pixels, counting from the top left corner of @var{window}'s frame. |
6547 | 777 |
778 If @var{position} is @code{t}, it means to use the current mouse | |
779 position. If @var{position} is @code{nil}, it means to precompute the | |
780 key binding equivalents for the keymaps specified in @var{menu}, | |
781 without actually displaying or popping up the menu. | |
782 | |
783 The argument @var{menu} says what to display in the menu. It can be a | |
784 keymap or a list of keymaps (@pxref{Menu Keymaps}). Alternatively, it | |
785 can have the following form: | |
786 | |
787 @example | |
788 (@var{title} @var{pane1} @var{pane2}...) | |
789 @end example | |
790 | |
791 @noindent | |
792 where each pane is a list of form | |
793 | |
794 @example | |
795 (@var{title} (@var{line} @var{item})...) | |
796 @end example | |
797 | |
798 Each @var{line} should be a string, and each @var{item} should be the | |
799 value to return if that @var{line} is chosen. | |
800 @end defun | |
801 | |
802 @strong{Usage note:} Don't use @code{x-popup-menu} to display a menu if | |
803 a prefix key with a menu keymap would do the job. If you use a menu | |
804 keymap to implement a menu, @kbd{C-h c} and @kbd{C-h a} can see the | |
805 individual items in that menu and provide help for them. If instead you | |
806 implement the menu by defining a command that calls @code{x-popup-menu}, | |
807 the help facilities cannot know what happens inside that command, so | |
808 they cannot give any help for the menu's items. This is the reason why | |
809 all the menu bar items except @samp{Buffers} are implemented with menu | |
810 keymaps (@pxref{Menu Keymaps}). | |
811 | |
812 @node Dialog Boxes | |
813 @section Dialog Boxes | |
814 @cindex dialog boxes | |
815 | |
816 A dialog box is a variant of a pop-up menu. It looks a little | |
817 different (if Emacs uses an X toolkit), it always appears in the center | |
818 of a frame, and it has just one level and one pane. The main use of | |
819 dialog boxes is for asking questions that the user can answer with | |
820 ``yes'', ``no'', and a few other alternatives. The functions | |
821 @code{y-or-n-p} and @code{yes-or-no-p} use dialog boxes instead of the | |
822 keyboard, when called from commands invoked by mouse clicks. | |
823 | |
824 @defun x-popup-dialog position contents | |
825 This function displays a pop-up dialog box and returns an indication of | |
826 what selection the user makes. The argument @var{contents} specifies | |
827 the alternatives to offer; it has this format: | |
828 | |
829 @example | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
830 (@var{title} (@var{string} . @var{value})@dots{}) |
6547 | 831 @end example |
832 | |
833 @noindent | |
834 which looks like the list that specifies a single pane for | |
835 @code{x-popup-menu}. | |
836 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
837 The return value is @var{value} from the chosen alternative. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
838 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
839 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
|
840 @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
|
841 be selected. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
842 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
843 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
|
844 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
|
845 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
|
846 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
|
847 items appear on each side. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
848 |
6547 | 849 Dialog boxes always appear in the center of a frame; the argument |
850 @var{position} specifies which frame. The possible values are as in | |
851 @code{x-popup-menu}, but the precise coordinates don't matter; only the | |
852 frame matters. | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
853 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
854 If your Emacs executable does not use an X toolkit, then it cannot |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
855 display a real dialog box; so instead it displays the same items in a |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
856 pop-up menu in the center of the frame. |
6547 | 857 @end defun |
858 | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
859 @node Pointer Shapes |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
860 @section Pointer Shapes |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
861 @cindex pointer shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
862 @cindex mouse pointer shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
863 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
864 These variables specify which mouse pointer shape to use in various |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
865 situations: |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
866 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
867 @table @code |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
868 @item x-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
869 @vindex x-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
870 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
|
871 frame. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
872 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
873 @item x-sensitive-text-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
874 @vindex x-sensitive-text-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
875 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
|
876 is over mouse-sensitive text. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
877 @end table |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
878 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
879 These variables affect newly created frames. They do not normally |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
880 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
|
881 that also updates its pointer shapes based on the current values of |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
882 these variables. @xref{X Frame Parameters}. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
883 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
884 The values you can use, to specify either of these pointer shapes, are |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
885 defined in the file @file{lisp/x-win.el}. Use @kbd{M-x apropos |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
886 @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
|
887 |
6547 | 888 @node X Selections |
889 @section X Selections | |
890 @cindex selection (for X windows) | |
891 | |
892 The X server records a set of @dfn{selections} which permit transfer of | |
893 data between application programs. The various selections are | |
894 distinguished by @dfn{selection types}, represented in Emacs by | |
895 symbols. X clients including Emacs can read or set the selection for | |
896 any given type. | |
897 | |
898 @defun x-set-selection type data | |
899 This function sets a ``selection'' in the X server. It takes two | |
900 arguments: a selection type @var{type}, and the value to assign to it, | |
901 @var{data}. If @var{data} is @code{nil}, it means to clear out the | |
902 selection. Otherwise, @var{data} may be a string, a symbol, an integer | |
903 (or a cons of two integers or list of two integers), an overlay, or a | |
904 cons of two markers pointing to the same buffer. An overlay or a pair | |
905 of markers stands for text in the overlay or between the markers. | |
906 | |
907 The data may also be a vector of valid non-vector selection values. | |
908 | |
909 Each possible @var{type} has its own selection value, which changes | |
910 independently. The usual values of @var{type} are @code{PRIMARY} and | |
911 @code{SECONDARY}; these are symbols with upper-case names, in accord | |
912 with X Window System conventions. The default is @code{PRIMARY}. | |
913 @end defun | |
914 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
915 @defun x-get-selection &optional type data-type |
6547 | 916 This function accesses selections set up by Emacs or by other X |
917 clients. It takes two optional arguments, @var{type} and | |
918 @var{data-type}. The default for @var{type}, the selection type, is | |
919 @code{PRIMARY}. | |
920 | |
921 The @var{data-type} argument specifies the form of data conversion to | |
922 use, to convert the raw data obtained from another X client into Lisp | |
923 data. Meaningful values include @code{TEXT}, @code{STRING}, | |
924 @code{TARGETS}, @code{LENGTH}, @code{DELETE}, @code{FILE_NAME}, | |
925 @code{CHARACTER_POSITION}, @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, | |
926 @code{OWNER_OS}, @code{HOST_NAME}, @code{USER}, @code{CLASS}, | |
927 @code{NAME}, @code{ATOM}, and @code{INTEGER}. (These are symbols with | |
928 upper-case names in accord with X conventions.) The default for | |
929 @var{data-type} is @code{STRING}. | |
930 @end defun | |
931 | |
932 @cindex cut buffer | |
933 The X server also has a set of numbered @dfn{cut buffers} which can | |
934 store text or other data being moved between applications. Cut buffers | |
935 are considered obsolete, but Emacs supports them for the sake of X | |
936 clients that still use them. | |
937 | |
938 @defun x-get-cut-buffer n | |
939 This function returns the contents of cut buffer number @var{n}. | |
940 @end defun | |
941 | |
942 @defun x-set-cut-buffer string | |
943 This function stores @var{string} into the first cut buffer (cut buffer | |
944 0), moving the other values down through the series of cut buffers, much | |
945 like the way successive kills in Emacs move down the kill ring. | |
946 @end defun | |
947 | |
948 @node X Connections | |
949 @section X Connections | |
950 | |
951 You can close the connection with the X server with the function | |
952 @code{x-close-current-connection}, and open a new one with | |
953 @code{x-open-connection} (perhaps with a different server and display). | |
954 | |
955 @defun x-close-current-connection | |
956 This function closes the connection to the X server. It deletes all | |
957 frames, making Emacs effectively inaccessible to the user; therefore, a | |
958 Lisp program that closes the connection should open another one. | |
959 @end defun | |
960 | |
961 @defun x-open-connection display &optional resource-string | |
962 This function opens a connection to an X server, for use of display | |
963 @var{display}. | |
964 | |
965 The optional argument @var{resource-string} is a string of resource | |
966 names and values, in the same format used in the @file{.Xresources} | |
967 file. The values you specify override the resource values recorded in | |
968 the X server itself. Here's an example of what this string might look | |
969 like: | |
970 | |
971 @example | |
972 "*BorderWidth: 3\n*InternalBorder: 2\n" | |
973 @end example | |
974 | |
975 @xref{Resources}. | |
976 @end defun | |
977 | |
978 @defun x-display-color-p | |
979 This returns @code{t} if the connected X display has color, and | |
980 @code{nil} otherwise. | |
981 @end defun | |
982 | |
983 @defun x-color-defined-p color | |
8712 | 984 This function reports whether a color name is meaningful. It returns |
985 @code{t} if so; otherwise, @code{nil}. | |
986 | |
987 Note that this does not tell you whether the display you are using | |
988 really supports that color. You can ask for any defined color on any | |
989 kind of display, and you will get some result---that is how the X server | |
990 works. Here's an approximate way to test whether your display supports | |
991 the color @var{color}: | |
992 | |
993 @example | |
994 (defun x-color-supported-p (color) | |
995 (and (x-color-defined-p color) | |
996 (or (x-display-color-p) | |
997 (member color '("black" "white")) | |
998 (and (> (x-display-planes) 1) | |
999 (equal color "gray"))))) | |
1000 @end example | |
1001 @end defun | |
6547 | 1002 |
8712 | 1003 @defun x-color-values color |
1004 This function returns a value that describes what @var{color} should | |
1005 ideally look like. If @var{color} is defined, the value is a list of | |
1006 three integers, which give the amount of red, the amount of green, and | |
1007 the amount of blue. Each integer ranges in principle from 0 to 65535, | |
1008 but in practice no value seems to be above 65280. If @var{color} is not | |
1009 defined, the value is @code{nil}. | |
1010 | |
1011 @example | |
1012 (x-color-values "black") | |
1013 @result{} (0 0 0) | |
1014 (x-color-values "white") | |
1015 @result{} (65280 65280 65280) | |
1016 (x-color-values "red") | |
1017 @result{} (65280 0 0) | |
1018 (x-color-values "pink") | |
1019 @result{} (65280 49152 51968) | |
1020 (x-color-values "hungry") | |
1021 @result{} nil | |
1022 @end example | |
6547 | 1023 @end defun |
1024 | |
1025 @defun x-synchronize flag | |
1026 The function @code{x-synchronize} enables or disables synchronous | |
1027 communication with the X server. It enables synchronous communication | |
1028 if @var{flag} is non-@code{nil}, and disables it if @var{flag} is | |
1029 @code{nil}. | |
1030 | |
1031 In synchronous mode, Emacs waits for a response to each X protocol | |
1032 command before doing anything else. This is useful for debugging Emacs, | |
1033 because protocol errors are reported right away, which helps you find | |
1034 the erroneous command. Synchronous mode is not the default because it | |
1035 is much slower. | |
1036 @end defun | |
1037 | |
1038 @node Resources | |
1039 @section X Resources | |
1040 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1041 @defun x-get-resource attribute &optional component subclass |
6547 | 1042 The function @code{x-get-resource} retrieves a resource value from the X |
1043 Windows defaults database. | |
1044 | |
1045 Resources are indexed by a combination of a @dfn{key} and a @dfn{class}. | |
1046 This function searches using a key of the form | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1047 @samp{@var{instance}.@var{attribute}} (where @var{instance} is the name |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1048 under which Emacs was invoked), and using @samp{Emacs} as the class. |
6547 | 1049 |
1050 The optional arguments @var{component} and @var{subclass} add to the key | |
1051 and the class, respectively. You must specify both of them or neither. | |
1052 If you specify them, the key is | |
1053 @samp{@var{instance}.@var{component}.@var{attribute}}, and the class is | |
1054 @samp{Emacs.@var{subclass}}. | |
1055 @end defun | |
1056 | |
1057 @xref{Resources X, X Resources,, emacs, The GNU Emacs Manual}. | |
1058 | |
1059 @node Server Data | |
1060 @section Data about the X Server | |
1061 | |
1062 This section describes functions and a variable that you can use to | |
1063 get information about the capabilities and origin of the X server that | |
1064 Emacs is displaying its frames on. | |
1065 | |
1066 @defun x-display-screens | |
1067 This function returns the number of screens associated with the current | |
1068 display. | |
1069 @end defun | |
1070 | |
1071 @defun x-server-version | |
1072 This function returns the list of version numbers of the X server in | |
1073 use. | |
1074 @end defun | |
1075 | |
1076 @defun x-server-vendor | |
1077 This function returns the vendor supporting the X server in use. | |
1078 @end defun | |
1079 | |
1080 @defun x-display-pixel-height | |
1081 This function returns the height of this X screen in pixels. | |
1082 @end defun | |
1083 | |
1084 @defun x-display-mm-height | |
1085 This function returns the height of this X screen in millimeters. | |
1086 @end defun | |
1087 | |
1088 @defun x-display-pixel-width | |
1089 This function returns the width of this X screen in pixels. | |
1090 @end defun | |
1091 | |
1092 @defun x-display-mm-width | |
1093 This function returns the width of this X screen in millimeters. | |
1094 @end defun | |
1095 | |
1096 @defun x-display-backing-store | |
1097 This function returns the backing store capability of this screen. | |
1098 Values can be the symbols @code{always}, @code{when-mapped}, or | |
1099 @code{not-useful}. | |
1100 @end defun | |
1101 | |
1102 @defun x-display-save-under | |
1103 This function returns non-@code{nil} if this X screen supports the | |
1104 SaveUnder feature. | |
1105 @end defun | |
1106 | |
1107 @defun x-display-planes | |
1108 This function returns the number of planes this display supports. | |
1109 @end defun | |
1110 | |
1111 @defun x-display-visual-class | |
1112 This function returns the visual class for this X screen. The value is | |
1113 one of the symbols @code{static-gray}, @code{gray-scale}, | |
1114 @code{static-color}, @code{pseudo-color}, @code{true-color}, and | |
1115 @code{direct-color}. | |
1116 @end defun | |
1117 | |
1118 @defun x-display-color-p | |
1119 This function returns @code{t} if the X screen in use is a color | |
1120 screen. | |
1121 @end defun | |
1122 | |
1123 @defun x-display-color-cells | |
1124 This function returns the number of color cells this X screen supports. | |
1125 @end defun | |
1126 | |
1127 @ignore | |
1128 @defvar x-no-window-manager | |
1129 This variable's value is is @code{t} if no X window manager is in use. | |
1130 @end defvar | |
1131 @end ignore | |
1132 | |
1133 @ignore | |
1134 @item | |
1135 The functions @code{x-pixel-width} and @code{x-pixel-height} return the | |
1136 width and height of an X Window frame, measured in pixels. | |
1137 @end ignore |