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