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