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