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