Mercurial > emacs
annotate doc/lispref/frames.texi @ 98978:f570df2cc52d
*** empty log message ***
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Tue, 21 Oct 2008 13:46:08 +0000 |
parents | 5919c911fb16 |
children | 3153b9e9ea3f |
rev | line source |
---|---|
84068 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001, | |
87649 | 4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
84068 | 5 @c See the file elisp.texi for copying conditions. |
84116
0ba80d073e27
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84068
diff
changeset
|
6 @setfilename ../../info/frames |
84068 | 7 @node Frames, Positions, Windows, Top |
8 @chapter Frames | |
9 @cindex frame | |
10 | |
11 In Emacs editing, A @dfn{frame} is a screen object that contains one | |
12 or more Emacs windows. It's the kind of object that is called a | |
13 ``window'' in the terminology of graphical environments; but we can't | |
14 call it a ``window'' here, because Emacs uses that word in a different | |
15 way. | |
16 | |
17 A frame initially contains a single main window and/or a minibuffer | |
18 window; you can subdivide the main window vertically or horizontally | |
19 into smaller windows. In Emacs Lisp, a @dfn{frame object} is a Lisp | |
20 object that represents a frame on the screen. | |
21 | |
22 @cindex terminal frame | |
23 When Emacs runs on a text-only terminal, it starts with one | |
98681
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
24 @dfn{terminal frame}. If you create additional frames on the same |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
25 terminal, Emacs displays one and only one at any given time---on that |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
26 terminal screen, of course. You can create additional frames, either |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
27 text-only or GUI, on other terminals from the same Emacs session. |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
28 (This comes in handy when you connect to the same session from several |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
29 remote locations.) @c FIXME: Add an xref to multi-tty doc. |
84068 | 30 |
31 @cindex window frame | |
32 When Emacs communicates directly with a supported window system, such | |
33 as X, it does not have a terminal frame; instead, it starts with | |
34 a single @dfn{window frame}, but you can create more, and Emacs can | |
35 display several such frames at once as is usual for window systems. | |
36 | |
37 @defun framep object | |
38 This predicate returns a non-@code{nil} value if @var{object} is a | |
39 frame, and @code{nil} otherwise. For a frame, the value indicates which | |
40 kind of display the frame uses: | |
41 | |
42 @table @code | |
43 @item x | |
44 The frame is displayed in an X window. | |
45 @item t | |
46 A terminal frame on a character display. | |
47 @item w32 | |
48 The frame is displayed on MS-Windows 9X/NT. | |
49 @item pc | |
50 The frame is displayed on an MS-DOS terminal. | |
51 @end table | |
52 @end defun | |
53 | |
54 @menu | |
55 * Creating Frames:: Creating additional frames. | |
56 * Multiple Displays:: Creating frames on other displays. | |
57 * Frame Parameters:: Controlling frame size, position, font, etc. | |
58 * Frame Titles:: Automatic updating of frame titles. | |
59 * Deleting Frames:: Frames last until explicitly deleted. | |
60 * Finding All Frames:: How to examine all existing frames. | |
61 * Frames and Windows:: A frame contains windows; | |
62 display of text always works through windows. | |
63 * Minibuffers and Frames:: How a frame finds the minibuffer to use. | |
64 * Input Focus:: Specifying the selected frame. | |
65 * Visibility of Frames:: Frames may be visible or invisible, or icons. | |
66 * Raising and Lowering:: Raising a frame makes it hide other windows; | |
67 lowering it makes the others hide it. | |
68 * Frame Configurations:: Saving the state of all frames. | |
69 * Mouse Tracking:: Getting events that say when the mouse moves. | |
70 * Mouse Position:: Asking where the mouse is, or moving it. | |
71 * Pop-Up Menus:: Displaying a menu for the user to select from. | |
72 * Dialog Boxes:: Displaying a box to ask yes or no. | |
73 * Pointer Shape:: Specifying the shape of the mouse pointer. | |
74 * Window System Selections:: Transferring text to and from other X clients. | |
75 * Drag and Drop:: Internals of Drag-and-Drop implementation. | |
76 * Color Names:: Getting the definitions of color names. | |
77 * Text Terminal Colors:: Defining colors for text-only terminals. | |
78 * Resources:: Getting resource values from the server. | |
79 * Display Feature Testing:: Determining the features of a terminal. | |
80 @end menu | |
81 | |
82 @xref{Display}, for information about the related topic of | |
83 controlling Emacs redisplay. | |
84 | |
85 @node Creating Frames | |
86 @section Creating Frames | |
87 | |
88 To create a new frame, call the function @code{make-frame}. | |
89 | |
90 @defun make-frame &optional alist | |
91 This function creates and returns a new frame, displaying the current | |
92 buffer. If you are using a supported window system, it makes a window | |
93 frame; otherwise, it makes a terminal frame. | |
94 | |
95 The argument is an alist specifying frame parameters. Any parameters | |
96 not mentioned in @var{alist} default according to the value of the | |
97 variable @code{default-frame-alist}; parameters not specified even there | |
98 default from the standard X resources or whatever is used instead on | |
99 your system. | |
100 | |
98737
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
101 After the frame is created, this function applies to it the |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
102 parameters, if any, listed in the value of |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
103 @code{frame-inherited-parameters} (see below) and not present in the |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
104 argument, taking the values from the frame that was selected when |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
105 @code{make-frame} was called. |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
106 |
84068 | 107 The set of possible parameters depends in principle on what kind of |
108 window system Emacs uses to display its frames. @xref{Window Frame | |
109 Parameters}, for documentation of individual parameters you can specify. | |
110 | |
111 This function itself does not make the new frame the selected frame. | |
112 @xref{Input Focus}. The previously selected frame remains selected. | |
113 However, the window system may select the new frame for its own reasons, | |
114 for instance if the frame appears under the mouse pointer and your | |
115 setup is for focus to follow the pointer. | |
116 @end defun | |
117 | |
118 @defvar before-make-frame-hook | |
119 A normal hook run by @code{make-frame} before it actually creates the | |
120 frame. | |
121 @end defvar | |
122 | |
123 @defvar after-make-frame-functions | |
124 An abnormal hook run by @code{make-frame} after it creates the frame. | |
125 Each function in @code{after-make-frame-functions} receives one argument, the | |
126 frame just created. | |
127 @end defvar | |
128 | |
98737
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
129 @defvar frame-inherited-parameters |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
130 This variable specifies the list of frame parameters that a newly |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
131 created frame inherits from the currently selected frame. For each |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
132 parameter (a symbol) that is an element in the list and is not present |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
133 in the argument to @code{make-frame}, the function sets the value of |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
134 that parameter in the created frame to its value in the selected |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
135 frame. |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
136 @end defvar |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
137 |
84068 | 138 @node Multiple Displays |
139 @section Multiple Displays | |
140 @cindex multiple X displays | |
141 @cindex displays, multiple | |
142 | |
143 A single Emacs can talk to more than one X display. | |
144 Initially, Emacs uses just one display---the one chosen with the | |
145 @code{DISPLAY} environment variable or with the @samp{--display} option | |
146 (@pxref{Initial Options,,, emacs, The GNU Emacs Manual}). To connect to | |
147 another display, use the command @code{make-frame-on-display} or specify | |
148 the @code{display} frame parameter when you create the frame. | |
149 | |
150 Emacs treats each X server as a separate terminal, giving each one its | |
151 own selected frame and its own minibuffer windows. However, only one of | |
152 those frames is ``@emph{the} selected frame'' at any given moment, see | |
153 @ref{Input Focus}. | |
154 | |
155 A few Lisp variables are @dfn{terminal-local}; that is, they have a | |
156 separate binding for each terminal. The binding in effect at any time | |
157 is the one for the terminal that the currently selected frame belongs | |
158 to. These variables include @code{default-minibuffer-frame}, | |
159 @code{defining-kbd-macro}, @code{last-kbd-macro}, and | |
160 @code{system-key-alist}. They are always terminal-local, and can never | |
85688 | 161 be buffer-local (@pxref{Buffer-Local Variables}). |
84068 | 162 |
163 A single X server can handle more than one screen. A display name | |
164 @samp{@var{host}:@var{server}.@var{screen}} has three parts; the last | |
165 part specifies the screen number for a given server. When you use two | |
166 screens belonging to one server, Emacs knows by the similarity in their | |
167 names that they share a single keyboard, and it treats them as a single | |
168 terminal. | |
169 | |
170 Note that some graphical terminals can output to more than a one | |
171 monitor (or other output device) at the same time. On these | |
172 ``multi-monitor'' setups, a single @var{display} value controls the | |
173 output to all the physical monitors. In this situation, there is | |
174 currently no platform-independent way for Emacs to distinguish between | |
175 the different physical monitors. | |
176 | |
177 @deffn Command make-frame-on-display display &optional parameters | |
178 This creates and returns a new frame on display @var{display}, taking | |
179 the other frame parameters from @var{parameters}. Aside from the | |
180 @var{display} argument, it is like @code{make-frame} (@pxref{Creating | |
181 Frames}). | |
182 @end deffn | |
183 | |
184 @defun x-display-list | |
185 This returns a list that indicates which X displays Emacs has a | |
186 connection to. The elements of the list are strings, and each one is | |
187 a display name. | |
188 @end defun | |
189 | |
190 @defun x-open-connection display &optional xrm-string must-succeed | |
191 This function opens a connection to the X display @var{display}. It | |
192 does not create a frame on that display, but it permits you to check | |
193 that communication can be established with that display. | |
194 | |
195 The optional argument @var{xrm-string}, if not @code{nil}, is a | |
196 string of resource names and values, in the same format used in the | |
197 @file{.Xresources} file. The values you specify override the resource | |
198 values recorded in the X server itself; they apply to all Emacs frames | |
199 created on this display. Here's an example of what this string might | |
200 look like: | |
201 | |
202 @example | |
203 "*BorderWidth: 3\n*InternalBorder: 2\n" | |
204 @end example | |
205 | |
206 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}. | |
207 | |
208 If @var{must-succeed} is non-@code{nil}, failure to open the connection | |
209 terminates Emacs. Otherwise, it is an ordinary Lisp error. | |
210 @end defun | |
211 | |
212 @defun x-close-connection display | |
213 This function closes the connection to display @var{display}. Before | |
214 you can do this, you must first delete all the frames that were open on | |
215 that display (@pxref{Deleting Frames}). | |
216 @end defun | |
217 | |
218 @node Frame Parameters | |
219 @section Frame Parameters | |
220 @cindex frame parameters | |
221 | |
222 A frame has many parameters that control its appearance and behavior. | |
223 Just what parameters a frame has depends on what display mechanism it | |
224 uses. | |
225 | |
226 Frame parameters exist mostly for the sake of window systems. A | |
227 terminal frame has a few parameters, mostly for compatibility's sake; | |
228 only the @code{height}, @code{width}, @code{name}, @code{title}, | |
229 @code{menu-bar-lines}, @code{buffer-list} and @code{buffer-predicate} | |
230 parameters do something special. If the terminal supports colors, the | |
231 parameters @code{foreground-color}, @code{background-color}, | |
232 @code{background-mode} and @code{display-type} are also meaningful. | |
233 | |
98681
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
234 You can use frame parameters to define frame-local bindings for |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
235 variables. @xref{Frame-Local Variables}. |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
236 |
84068 | 237 @menu |
238 * Parameter Access:: How to change a frame's parameters. | |
239 * Initial Parameters:: Specifying frame parameters when you make a frame. | |
240 * Window Frame Parameters:: List of frame parameters for window systems. | |
241 * Size and Position:: Changing the size and position of a frame. | |
242 * Geometry:: Parsing geometry specifications. | |
243 @end menu | |
244 | |
245 @node Parameter Access | |
246 @subsection Access to Frame Parameters | |
247 | |
248 These functions let you read and change the parameter values of a | |
249 frame. | |
250 | |
251 @defun frame-parameter frame parameter | |
252 This function returns the value of the parameter @var{parameter} (a | |
253 symbol) of @var{frame}. If @var{frame} is @code{nil}, it returns the | |
254 selected frame's parameter. If @var{frame} has no setting for | |
255 @var{parameter}, this function returns @code{nil}. | |
256 @end defun | |
257 | |
258 @defun frame-parameters &optional frame | |
259 The function @code{frame-parameters} returns an alist listing all the | |
260 parameters of @var{frame} and their values. If @var{frame} is | |
261 @code{nil} or omitted, this returns the selected frame's parameters | |
262 @end defun | |
263 | |
264 @defun modify-frame-parameters frame alist | |
265 This function alters the parameters of frame @var{frame} based on the | |
266 elements of @var{alist}. Each element of @var{alist} has the form | |
267 @code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a | |
268 parameter. If you don't mention a parameter in @var{alist}, its value | |
269 doesn't change. If @var{frame} is @code{nil}, it defaults to the selected | |
270 frame. | |
98681
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
271 |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
272 You can use this function to define frame-local bindings for |
8be1f0e1f72d
(Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents:
97043
diff
changeset
|
273 variables, see @ref{Frame-Local Variables}. |
84068 | 274 @end defun |
275 | |
98737
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
276 @defun set-frame-parameter frame parm value |
98755
9fdc192b2742
(Creating Frames): Fix typo in last change.
Eli Zaretskii <eliz@gnu.org>
parents:
98737
diff
changeset
|
277 This function sets the frame parameter @var{parm} to the specified |
98737
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
278 @var{value}. If @var{frame} is @code{nil}, it defaults to the |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
279 selected frame. |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
280 @end defun |
40fea3019362
(Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents:
98681
diff
changeset
|
281 |
84068 | 282 @defun modify-all-frames-parameters alist |
283 This function alters the frame parameters of all existing frames | |
284 according to @var{alist}, then modifies @code{default-frame-alist} | |
285 (and, if necessary, @code{initial-frame-alist}) to apply the same | |
286 parameter values to frames that will be created henceforth. | |
287 @end defun | |
288 | |
289 @node Initial Parameters | |
290 @subsection Initial Frame Parameters | |
291 | |
292 You can specify the parameters for the initial startup frame | |
293 by setting @code{initial-frame-alist} in your init file (@pxref{Init File}). | |
294 | |
295 @defvar initial-frame-alist | |
296 This variable's value is an alist of parameter values used when creating | |
297 the initial window frame. You can set this variable to specify the | |
298 appearance of the initial frame without altering subsequent frames. | |
299 Each element has the form: | |
300 | |
301 @example | |
302 (@var{parameter} . @var{value}) | |
303 @end example | |
304 | |
305 Emacs creates the initial frame before it reads your init | |
306 file. After reading that file, Emacs checks @code{initial-frame-alist}, | |
307 and applies the parameter settings in the altered value to the already | |
308 created initial frame. | |
309 | |
310 If these settings affect the frame geometry and appearance, you'll see | |
311 the frame appear with the wrong ones and then change to the specified | |
312 ones. If that bothers you, you can specify the same geometry and | |
313 appearance with X resources; those do take effect before the frame is | |
314 created. @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}. | |
315 | |
316 X resource settings typically apply to all frames. If you want to | |
317 specify some X resources solely for the sake of the initial frame, and | |
318 you don't want them to apply to subsequent frames, here's how to achieve | |
319 this. Specify parameters in @code{default-frame-alist} to override the | |
320 X resources for subsequent frames; then, to prevent these from affecting | |
321 the initial frame, specify the same parameters in | |
322 @code{initial-frame-alist} with values that match the X resources. | |
323 @end defvar | |
324 | |
325 If these parameters specify a separate minibuffer-only frame with | |
326 @code{(minibuffer . nil)}, and you have not created one, Emacs creates | |
327 one for you. | |
328 | |
329 @defvar minibuffer-frame-alist | |
330 This variable's value is an alist of parameter values used when creating | |
331 an initial minibuffer-only frame---if such a frame is needed, according | |
332 to the parameters for the main initial frame. | |
333 @end defvar | |
334 | |
335 @defvar default-frame-alist | |
336 This is an alist specifying default values of frame parameters for all | |
337 Emacs frames---the first frame, and subsequent frames. When using the X | |
338 Window System, you can get the same results by means of X resources | |
339 in many cases. | |
340 | |
341 Setting this variable does not affect existing frames. | |
342 @end defvar | |
343 | |
344 See also @code{special-display-frame-alist}. @xref{Definition of | |
345 special-display-frame-alist}. | |
346 | |
347 If you use options that specify window appearance when you invoke Emacs, | |
348 they take effect by adding elements to @code{default-frame-alist}. One | |
349 exception is @samp{-geometry}, which adds the specified position to | |
350 @code{initial-frame-alist} instead. @xref{Emacs Invocation,, Command | |
351 Line Arguments for Emacs Invocation, emacs, The GNU Emacs Manual}. | |
352 | |
353 @node Window Frame Parameters | |
354 @subsection Window Frame Parameters | |
355 | |
356 Just what parameters a frame has depends on what display mechanism | |
357 it uses. This section describes the parameters that have special | |
358 meanings on some or all kinds of terminals. Of these, @code{name}, | |
359 @code{title}, @code{height}, @code{width}, @code{buffer-list} and | |
360 @code{buffer-predicate} provide meaningful information in terminal | |
361 frames, and @code{tty-color-mode} is meaningful @emph{only} in | |
362 terminal frames. | |
363 | |
364 @menu | |
365 * Basic Parameters:: Parameters that are fundamental. | |
366 * Position Parameters:: The position of the frame on the screen. | |
367 * Size Parameters:: Frame's size. | |
368 * Layout Parameters:: Size of parts of the frame, and | |
369 enabling or disabling some parts. | |
370 * Buffer Parameters:: Which buffers have been or should be shown. | |
371 * Management Parameters:: Communicating with the window manager. | |
372 * Cursor Parameters:: Controlling the cursor appearance. | |
373 * Color Parameters:: Colors of various parts of the frame. | |
374 @end menu | |
375 | |
376 @node Basic Parameters | |
377 @subsubsection Basic Parameters | |
378 | |
379 These frame parameters give the most basic information about the | |
380 frame. @code{title} and @code{name} are meaningful on all terminals. | |
381 | |
382 @table @code | |
383 @item display | |
384 The display on which to open this frame. It should be a string of the | |
385 form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the | |
386 @code{DISPLAY} environment variable. | |
387 | |
388 @item display-type | |
389 This parameter describes the range of possible colors that can be used | |
390 in this frame. Its value is @code{color}, @code{grayscale} or | |
391 @code{mono}. | |
392 | |
393 @item title | |
87453 | 394 If a frame has a non-@code{nil} title, it appears in the window |
395 system's title bar at the top of the frame, and also in the mode line | |
396 of windows in that frame if @code{mode-line-frame-identification} uses | |
397 @samp{%F} (@pxref{%-Constructs}). This is normally the case when | |
398 Emacs is not using a window system, and can only display one frame at | |
399 a time. @xref{Frame Titles}. | |
84068 | 400 |
401 @item name | |
402 The name of the frame. The frame name serves as a default for the frame | |
403 title, if the @code{title} parameter is unspecified or @code{nil}. If | |
404 you don't specify a name, Emacs sets the frame name automatically | |
405 (@pxref{Frame Titles}). | |
406 | |
407 If you specify the frame name explicitly when you create the frame, the | |
408 name is also used (instead of the name of the Emacs executable) when | |
409 looking up X resources for the frame. | |
410 | |
411 @item display-environment-variable | |
412 The value of the @code{DISPLAY} environment variable for the frame. It | |
413 is passed to child processes. | |
414 | |
415 @item term-environment-variable | |
416 The value of the @code{TERM} environment variable for the frame. It | |
417 is passed to child processes. | |
418 @end table | |
419 | |
420 @node Position Parameters | |
421 @subsubsection Position Parameters | |
422 | |
423 Position parameters' values are normally measured in pixels, but on | |
424 text-only terminals they count characters or lines instead. | |
425 | |
426 @table @code | |
427 @item left | |
92098 | 428 The position, in pixels, of the left (or right) edge of the frame with |
429 respect to the left (or right) edge of the screen. The value may be: | |
92096
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
430 |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
431 @table @asis |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
432 @item an integer |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
433 A positive integer relates the left edge of the frame to the left edge |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
434 of the screen. A negative integer relates the right frame edge to the |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
435 right screen edge. |
84068 | 436 |
92096
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
437 @item @code{(+ @var{pos})} |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
438 This specifies the position of the left frame edge relative to the left |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
439 screen edge. The integer @var{pos} may be positive or negative; a |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
440 negative value specifies a position outside the screen. |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
441 |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
442 @item @code{(- @var{pos})} |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
443 This specifies the position of the right frame edge relative to the right |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
444 screen edge. The integer @var{pos} may be positive or negative; a |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
445 negative value specifies a position outside the screen. |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
446 @end table |
84068 | 447 |
448 Some window managers ignore program-specified positions. If you want to | |
449 be sure the position you specify is not ignored, specify a | |
450 non-@code{nil} value for the @code{user-position} parameter as well. | |
451 | |
452 @item top | |
92096
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
453 The screen position of the top (or bottom) edge, in pixels, with respect |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
454 to the top (or bottom) edge of the screen. It works just like |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
455 @code{left}, except vertically instead of horizontally. |
84068 | 456 |
457 @item icon-left | |
458 The screen position of the left edge @emph{of the frame's icon}, in | |
459 pixels, counting from the left edge of the screen. This takes effect if | |
460 and when the frame is iconified. | |
461 | |
462 If you specify a value for this parameter, then you must also specify | |
463 a value for @code{icon-top} and vice versa. The window manager may | |
464 ignore these two parameters. | |
465 | |
466 @item icon-top | |
467 The screen position of the top edge @emph{of the frame's icon}, in | |
468 pixels, counting from the top edge of the screen. This takes effect if | |
469 and when the frame is iconified. | |
470 | |
471 @item user-position | |
472 When you create a frame and specify its screen position with the | |
473 @code{left} and @code{top} parameters, use this parameter to say whether | |
474 the specified position was user-specified (explicitly requested in some | |
475 way by a human user) or merely program-specified (chosen by a program). | |
476 A non-@code{nil} value says the position was user-specified. | |
477 | |
478 Window managers generally heed user-specified positions, and some heed | |
479 program-specified positions too. But many ignore program-specified | |
480 positions, placing the window in a default fashion or letting the user | |
481 place it with the mouse. Some window managers, including @code{twm}, | |
482 let the user specify whether to obey program-specified positions or | |
483 ignore them. | |
484 | |
485 When you call @code{make-frame}, you should specify a non-@code{nil} | |
486 value for this parameter if the values of the @code{left} and @code{top} | |
487 parameters represent the user's stated preference; otherwise, use | |
488 @code{nil}. | |
489 @end table | |
490 | |
491 @node Size Parameters | |
492 @subsubsection Size Parameters | |
493 | |
494 Size parameters' values are normally measured in pixels, but on | |
495 text-only terminals they count characters or lines instead. | |
496 | |
497 @table @code | |
498 @item height | |
499 The height of the frame contents, in characters. (To get the height in | |
500 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) | |
501 | |
502 @item width | |
87453 | 503 The width of the frame contents, in characters. (To get the width in |
84068 | 504 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) |
505 | |
506 @item user-size | |
507 This does for the size parameters @code{height} and @code{width} what | |
508 the @code{user-position} parameter (see above) does for the position | |
509 parameters @code{top} and @code{left}. | |
510 | |
511 @item fullscreen | |
512 Specify that width, height or both shall be set to the size of the screen. | |
513 The value @code{fullwidth} specifies that width shall be the size of the | |
514 screen. The value @code{fullheight} specifies that height shall be the | |
515 size of the screen. The value @code{fullboth} specifies that both the | |
516 width and the height shall be set to the size of the screen. | |
517 @end table | |
518 | |
519 @node Layout Parameters | |
520 @subsubsection Layout Parameters | |
521 | |
522 These frame parameters enable or disable various parts of the | |
523 frame, or control their sizes. | |
524 | |
525 @table @code | |
526 @item border-width | |
527 The width in pixels of the frame's border. | |
528 | |
529 @item internal-border-width | |
530 The distance in pixels between text (or fringe) and the frame's border. | |
531 | |
532 @item vertical-scroll-bars | |
533 Whether the frame has scroll bars for vertical scrolling, and which side | |
534 of the frame they should be on. The possible values are @code{left}, | |
535 @code{right}, and @code{nil} for no scroll bars. | |
536 | |
537 @ignore | |
538 @item horizontal-scroll-bars | |
539 Whether the frame has scroll bars for horizontal scrolling | |
540 (non-@code{nil} means yes). Horizontal scroll bars are not currently | |
541 implemented. | |
542 @end ignore | |
543 | |
544 @item scroll-bar-width | |
545 The width of vertical scroll bars, in pixels, or @code{nil} meaning to | |
546 use the default width. | |
547 | |
548 @item left-fringe | |
549 @itemx right-fringe | |
550 The default width of the left and right fringes of windows in this | |
551 frame (@pxref{Fringes}). If either of these is zero, that effectively | |
552 removes the corresponding fringe. A value of @code{nil} stands for | |
553 the standard fringe width, which is the width needed to display the | |
554 fringe bitmaps. | |
555 | |
556 The combined fringe widths must add up to an integral number of | |
557 columns, so the actual default fringe widths for the frame may be | |
558 larger than the specified values. The extra width needed to reach an | |
559 acceptable total is distributed evenly between the left and right | |
560 fringe. However, you can force one fringe or the other to a precise | |
561 width by specifying that width as a negative integer. If both widths are | |
562 negative, only the left fringe gets the specified width. | |
563 | |
564 @item menu-bar-lines | |
565 The number of lines to allocate at the top of the frame for a menu | |
566 bar. The default is 1. A value of @code{nil} means don't display a | |
567 menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one | |
568 menu bar line; they treat larger values as 1.) | |
569 | |
570 @item tool-bar-lines | |
571 The number of lines to use for the tool bar. A value of @code{nil} | |
572 means don't display a tool bar. (GTK allows at most one tool bar line; | |
573 it treats larger values as 1.) | |
574 | |
575 @item line-spacing | |
576 Additional space to leave below each text line, in pixels (a positive | |
577 integer). @xref{Line Height}, for more information. | |
578 @end table | |
579 | |
580 @node Buffer Parameters | |
581 @subsubsection Buffer Parameters | |
582 | |
583 These frame parameters, meaningful on all kinds of terminals, deal | |
584 with which buffers have been, or should, be displayed in the frame. | |
585 | |
586 @table @code | |
587 @item minibuffer | |
588 Whether this frame has its own minibuffer. The value @code{t} means | |
589 yes, @code{nil} means no, @code{only} means this frame is just a | |
590 minibuffer. If the value is a minibuffer window (in some other frame), | |
591 the new frame uses that minibuffer. | |
592 | |
593 @item buffer-predicate | |
594 The buffer-predicate function for this frame. The function | |
595 @code{other-buffer} uses this predicate (from the selected frame) to | |
596 decide which buffers it should consider, if the predicate is not | |
597 @code{nil}. It calls the predicate with one argument, a buffer, once for | |
598 each buffer; if the predicate returns a non-@code{nil} value, it | |
599 considers that buffer. | |
600 | |
601 @item buffer-list | |
602 A list of buffers that have been selected in this frame, | |
603 ordered most-recently-selected first. | |
604 | |
605 @item unsplittable | |
606 If non-@code{nil}, this frame's window is never split automatically. | |
607 @end table | |
608 | |
609 @node Management Parameters | |
610 @subsubsection Window Management Parameters | |
611 @cindex window manager, and frame parameters | |
612 | |
613 These frame parameters, meaningful only on window system displays, | |
614 interact with the window manager. | |
615 | |
616 @table @code | |
617 @item visibility | |
618 The state of visibility of the frame. There are three possibilities: | |
619 @code{nil} for invisible, @code{t} for visible, and @code{icon} for | |
620 iconified. @xref{Visibility of Frames}. | |
621 | |
622 @item auto-raise | |
623 Whether selecting the frame raises it (non-@code{nil} means yes). | |
624 | |
625 @item auto-lower | |
626 Whether deselecting the frame lowers it (non-@code{nil} means yes). | |
627 | |
628 @item icon-type | |
629 The type of icon to use for this frame when it is iconified. If the | |
630 value is a string, that specifies a file containing a bitmap to use. | |
631 Any other non-@code{nil} value specifies the default bitmap icon (a | |
632 picture of a gnu); @code{nil} specifies a text icon. | |
633 | |
634 @item icon-name | |
635 The name to use in the icon for this frame, when and if the icon | |
636 appears. If this is @code{nil}, the frame's title is used. | |
637 | |
638 @item window-id | |
639 The number of the window-system window used by the frame | |
640 to contain the actual Emacs windows. | |
641 | |
642 @item outer-window-id | |
643 The number of the outermost window-system window used for the whole frame. | |
644 | |
645 @item wait-for-wm | |
646 If non-@code{nil}, tell Xt to wait for the window manager to confirm | |
647 geometry changes. Some window managers, including versions of Fvwm2 | |
648 and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to | |
649 prevent hanging with those window managers. | |
650 | |
651 @ignore | |
652 @item parent-id | |
653 @c ??? Not yet working. | |
654 The X window number of the window that should be the parent of this one. | |
655 Specifying this lets you create an Emacs window inside some other | |
656 application's window. (It is not certain this will be implemented; try | |
657 it and see if it works.) | |
658 @end ignore | |
659 @end table | |
660 | |
661 @node Cursor Parameters | |
662 @subsubsection Cursor Parameters | |
663 | |
664 This frame parameter controls the way the cursor looks. | |
665 | |
666 @table @code | |
667 @item cursor-type | |
668 How to display the cursor. Legitimate values are: | |
669 | |
670 @table @code | |
671 @item box | |
672 Display a filled box. (This is the default.) | |
673 @item hollow | |
674 Display a hollow box. | |
675 @item nil | |
676 Don't display a cursor. | |
677 @item bar | |
678 Display a vertical bar between characters. | |
679 @item (bar . @var{width}) | |
680 Display a vertical bar @var{width} pixels wide between characters. | |
681 @item hbar | |
682 Display a horizontal bar. | |
683 @item (hbar . @var{height}) | |
684 Display a horizontal bar @var{height} pixels high. | |
685 @end table | |
686 @end table | |
687 | |
688 @vindex cursor-type | |
689 The buffer-local variable @code{cursor-type} overrides the value of | |
690 the @code{cursor-type} frame parameter, but if it is @code{t}, that | |
691 means to use the cursor specified for the frame. | |
692 | |
693 @defvar blink-cursor-alist | |
694 This variable specifies how to blink the cursor. Each element has the | |
695 form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor | |
696 type equals @var{on-state} (comparing using @code{equal}), the | |
697 corresponding @var{off-state} specifies what the cursor looks like | |
698 when it blinks ``off.'' Both @var{on-state} and @var{off-state} | |
699 should be suitable values for the @code{cursor-type} frame parameter. | |
700 | |
701 There are various defaults for how to blink each type of cursor, if | |
702 the type is not mentioned as an @var{on-state} here. Changes in this | |
85114 | 703 variable do not take effect immediately, only when you specify the |
704 @code{cursor-type} frame parameter. | |
705 @end defvar | |
706 | |
707 @defvar cursor-in-non-selected-windows | |
708 This variable controls how the cursor looks in a window that is not | |
709 selected. It supports the same values as the @code{cursor-type} frame | |
710 parameter; also, @code{nil} means don't display a cursor in | |
711 nonselected windows, and @code{t} (the default) means use a standard | |
712 modificatoin of the usual cursor type (solid box becomes hollow box, | |
713 and bar becomes a narrower bar). | |
84068 | 714 @end defvar |
715 | |
716 @node Color Parameters | |
717 @subsubsection Color Parameters | |
718 | |
719 These frame parameters control the use of colors. | |
720 | |
721 @table @code | |
722 @item background-mode | |
723 This parameter is either @code{dark} or @code{light}, according | |
724 to whether the background color is a light one or a dark one. | |
725 | |
726 @item tty-color-mode | |
727 @cindex standard colors for character terminals | |
728 This parameter overrides the terminal's color support as given by the | |
729 system's terminal capabilities database in that this parameter's value | |
730 specifies the color mode to use in terminal frames. The value can be | |
731 either a symbol or a number. A number specifies the number of colors | |
732 to use (and, indirectly, what commands to issue to produce each | |
733 color). For example, @code{(tty-color-mode . 8)} specifies use of the | |
734 ANSI escape sequences for 8 standard text colors. A value of -1 turns | |
735 off color support. | |
736 | |
737 If the parameter's value is a symbol, it specifies a number through | |
738 the value of @code{tty-color-mode-alist}, and the associated number is | |
739 used instead. | |
740 | |
741 @item screen-gamma | |
742 @cindex gamma correction | |
743 If this is a number, Emacs performs ``gamma correction'' which adjusts | |
744 the brightness of all colors. The value should be the screen gamma of | |
745 your display, a floating point number. | |
746 | |
747 Usual PC monitors have a screen gamma of 2.2, so color values in | |
748 Emacs, and in X windows generally, are calibrated to display properly | |
749 on a monitor with that gamma value. If you specify 2.2 for | |
750 @code{screen-gamma}, that means no correction is needed. Other values | |
751 request correction, designed to make the corrected colors appear on | |
752 your screen the way they would have appeared without correction on an | |
753 ordinary monitor with a gamma value of 2.2. | |
754 | |
755 If your monitor displays colors too light, you should specify a | |
756 @code{screen-gamma} value smaller than 2.2. This requests correction | |
757 that makes colors darker. A screen gamma value of 1.5 may give good | |
758 results for LCD color displays. | |
759 @end table | |
760 | |
761 These frame parameters are semi-obsolete in that they are automatically | |
762 equivalent to particular face attributes of particular faces. | |
763 @xref{Standard Faces,,, emacs, The Emacs Manual}. | |
764 | |
765 @table @code | |
766 @item font | |
767 The name of the font for displaying text in the frame. This is a | |
768 string, either a valid font name for your system or the name of an Emacs | |
769 fontset (@pxref{Fontsets}). It is equivalent to the @code{font} | |
770 attribute of the @code{default} face. | |
771 | |
772 @item foreground-color | |
773 The color to use for the image of a character. It is equivalent to | |
774 the @code{:foreground} attribute of the @code{default} face. | |
775 | |
776 @item background-color | |
777 The color to use for the background of characters. It is equivalent to | |
778 the @code{:background} attribute of the @code{default} face. | |
779 | |
780 @item mouse-color | |
781 The color for the mouse pointer. It is equivalent to the @code{:background} | |
782 attribute of the @code{mouse} face. | |
783 | |
784 @item cursor-color | |
785 The color for the cursor that shows point. It is equivalent to the | |
786 @code{:background} attribute of the @code{cursor} face. | |
787 | |
788 @item border-color | |
789 The color for the border of the frame. It is equivalent to the | |
790 @code{:background} attribute of the @code{border} face. | |
791 | |
792 @item scroll-bar-foreground | |
793 If non-@code{nil}, the color for the foreground of scroll bars. It is | |
794 equivalent to the @code{:foreground} attribute of the | |
795 @code{scroll-bar} face. | |
796 | |
797 @item scroll-bar-background | |
798 If non-@code{nil}, the color for the background of scroll bars. It is | |
799 equivalent to the @code{:background} attribute of the | |
800 @code{scroll-bar} face. | |
801 @end table | |
802 | |
803 @node Size and Position | |
804 @subsection Frame Size And Position | |
805 @cindex size of frame | |
806 @cindex screen size | |
807 @cindex frame size | |
808 @cindex resize frame | |
809 | |
810 You can read or change the size and position of a frame using the | |
811 frame parameters @code{left}, @code{top}, @code{height}, and | |
812 @code{width}. Whatever geometry parameters you don't specify are chosen | |
813 by the window manager in its usual fashion. | |
814 | |
815 Here are some special features for working with sizes and positions. | |
816 (For the precise meaning of ``selected frame'' used by these functions, | |
817 see @ref{Input Focus}.) | |
818 | |
819 @defun set-frame-position frame left top | |
820 This function sets the position of the top left corner of @var{frame} to | |
821 @var{left} and @var{top}. These arguments are measured in pixels, and | |
822 normally count from the top left corner of the screen. | |
823 | |
824 Negative parameter values position the bottom edge of the window up from | |
825 the bottom edge of the screen, or the right window edge to the left of | |
826 the right edge of the screen. It would probably be better if the values | |
827 were always counted from the left and top, so that negative arguments | |
828 would position the frame partly off the top or left edge of the screen, | |
829 but it seems inadvisable to change that now. | |
830 @end defun | |
831 | |
832 @defun frame-height &optional frame | |
833 @defunx frame-width &optional frame | |
834 These functions return the height and width of @var{frame}, measured in | |
835 lines and columns. If you don't supply @var{frame}, they use the | |
836 selected frame. | |
837 @end defun | |
838 | |
839 @defun screen-height | |
840 @defunx screen-width | |
841 These functions are old aliases for @code{frame-height} and | |
842 @code{frame-width}. When you are using a non-window terminal, the size | |
843 of the frame is normally the same as the size of the terminal screen. | |
844 @end defun | |
845 | |
846 @defun frame-pixel-height &optional frame | |
847 @defunx frame-pixel-width &optional frame | |
87453 | 848 These functions return the height and width of the main display area |
849 of @var{frame}, measured in pixels. If you don't supply @var{frame}, | |
850 they use the selected frame. | |
851 | |
852 These values include the internal borders, and windows' scroll bars | |
853 and fringes (which belong to individual windows, not to the frame | |
854 itself), but do not include menu bars or tool bars (except when using | |
855 X without an X toolkit). | |
84068 | 856 @end defun |
857 | |
858 @defun frame-char-height &optional frame | |
859 @defunx frame-char-width &optional frame | |
860 These functions return the height and width of a character in | |
861 @var{frame}, measured in pixels. The values depend on the choice of | |
862 font. If you don't supply @var{frame}, these functions use the selected | |
863 frame. | |
864 @end defun | |
865 | |
866 @defun set-frame-size frame cols rows | |
867 This function sets the size of @var{frame}, measured in characters; | |
868 @var{cols} and @var{rows} specify the new width and height. | |
869 | |
870 To set the size based on values measured in pixels, use | |
871 @code{frame-char-height} and @code{frame-char-width} to convert | |
872 them to units of characters. | |
873 @end defun | |
874 | |
875 @defun set-frame-height frame lines &optional pretend | |
876 This function resizes @var{frame} to a height of @var{lines} lines. The | |
877 sizes of existing windows in @var{frame} are altered proportionally to | |
878 fit. | |
879 | |
880 If @var{pretend} is non-@code{nil}, then Emacs displays @var{lines} | |
881 lines of output in @var{frame}, but does not change its value for the | |
882 actual height of the frame. This is only useful for a terminal frame. | |
883 Using a smaller height than the terminal actually implements may be | |
884 useful to reproduce behavior observed on a smaller screen, or if the | |
885 terminal malfunctions when using its whole screen. Setting the frame | |
886 height ``for real'' does not always work, because knowing the correct | |
887 actual size may be necessary for correct cursor positioning on a | |
888 terminal frame. | |
889 @end defun | |
890 | |
891 @defun set-frame-width frame width &optional pretend | |
892 This function sets the width of @var{frame}, measured in characters. | |
893 The argument @var{pretend} has the same meaning as in | |
894 @code{set-frame-height}. | |
895 @end defun | |
896 | |
897 @findex set-screen-height | |
898 @findex set-screen-width | |
899 The older functions @code{set-screen-height} and | |
900 @code{set-screen-width} were used to specify the height and width of the | |
901 screen, in Emacs versions that did not support multiple frames. They | |
902 are semi-obsolete, but still work; they apply to the selected frame. | |
903 | |
904 @node Geometry | |
905 @subsection Geometry | |
906 | |
907 Here's how to examine the data in an X-style window geometry | |
908 specification: | |
909 | |
910 @defun x-parse-geometry geom | |
911 @cindex geometry specification | |
912 The function @code{x-parse-geometry} converts a standard X window | |
913 geometry string to an alist that you can use as part of the argument to | |
914 @code{make-frame}. | |
915 | |
916 The alist describes which parameters were specified in @var{geom}, and | |
917 gives the values specified for them. Each element looks like | |
918 @code{(@var{parameter} . @var{value})}. The possible @var{parameter} | |
919 values are @code{left}, @code{top}, @code{width}, and @code{height}. | |
920 | |
921 For the size parameters, the value must be an integer. The position | |
922 parameter names @code{left} and @code{top} are not totally accurate, | |
923 because some values indicate the position of the right or bottom edges | |
92096
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
924 instead. The @var{value} possibilities for the position parameters are: |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
925 an integer, a list @code{(+ @var{pos})}, or a list @code{(- @var{pos})}; |
6cc4c897d108
(Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
926 as previously described (@pxref{Position Parameters}). |
84068 | 927 |
928 Here is an example: | |
929 | |
930 @example | |
931 (x-parse-geometry "35x70+0-0") | |
932 @result{} ((height . 70) (width . 35) | |
933 (top - 0) (left . 0)) | |
934 @end example | |
935 @end defun | |
936 | |
937 @node Frame Titles | |
938 @section Frame Titles | |
939 @cindex frame title | |
940 | |
941 Every frame has a @code{name} parameter; this serves as the default | |
942 for the frame title which window systems typically display at the top of | |
943 the frame. You can specify a name explicitly by setting the @code{name} | |
944 frame property. | |
945 | |
946 Normally you don't specify the name explicitly, and Emacs computes the | |
947 frame name automatically based on a template stored in the variable | |
948 @code{frame-title-format}. Emacs recomputes the name each time the | |
949 frame is redisplayed. | |
950 | |
951 @defvar frame-title-format | |
952 This variable specifies how to compute a name for a frame when you have | |
953 not explicitly specified one. The variable's value is actually a mode | |
954 line construct, just like @code{mode-line-format}, except that the | |
955 @samp{%c} and @samp{%l} constructs are ignored. @xref{Mode Line | |
956 Data}. | |
957 @end defvar | |
958 | |
959 @defvar icon-title-format | |
960 This variable specifies how to compute the name for an iconified frame, | |
961 when you have not explicitly specified the frame title. This title | |
962 appears in the icon itself. | |
963 @end defvar | |
964 | |
965 @defvar multiple-frames | |
966 This variable is set automatically by Emacs. Its value is @code{t} when | |
967 there are two or more frames (not counting minibuffer-only frames or | |
968 invisible frames). The default value of @code{frame-title-format} uses | |
969 @code{multiple-frames} so as to put the buffer name in the frame title | |
970 only when there is more than one frame. | |
971 | |
972 The value of this variable is not guaranteed to be accurate except | |
973 while processing @code{frame-title-format} or | |
974 @code{icon-title-format}. | |
975 @end defvar | |
976 | |
977 @node Deleting Frames | |
978 @section Deleting Frames | |
979 @cindex deleting frames | |
980 | |
981 Frames remain potentially visible until you explicitly @dfn{delete} | |
982 them. A deleted frame cannot appear on the screen, but continues to | |
983 exist as a Lisp object until there are no references to it. | |
984 | |
985 @deffn Command delete-frame &optional frame force | |
986 @vindex delete-frame-functions | |
987 This function deletes the frame @var{frame}. Unless @var{frame} is a | |
988 tooltip, it first runs the hook @code{delete-frame-functions} (each | |
989 function gets one argument, @var{frame}). By default, @var{frame} is | |
990 the selected frame. | |
991 | |
992 A frame cannot be deleted if its minibuffer is used by other frames. | |
993 Normally, you cannot delete a frame if all other frames are invisible, | |
994 but if the @var{force} is non-@code{nil}, then you are allowed to do so. | |
995 @end deffn | |
996 | |
997 @defun frame-live-p frame | |
998 The function @code{frame-live-p} returns non-@code{nil} if the frame | |
999 @var{frame} has not been deleted. The possible non-@code{nil} return | |
1000 values are like those of @code{framep}. @xref{Frames}. | |
1001 @end defun | |
1002 | |
1003 Some window managers provide a command to delete a window. These work | |
1004 by sending a special message to the program that operates the window. | |
1005 When Emacs gets one of these commands, it generates a | |
1006 @code{delete-frame} event, whose normal definition is a command that | |
1007 calls the function @code{delete-frame}. @xref{Misc Events}. | |
1008 | |
1009 @node Finding All Frames | |
1010 @section Finding All Frames | |
1011 @cindex frames, scanning all | |
1012 | |
1013 @defun frame-list | |
1014 The function @code{frame-list} returns a list of all the frames that | |
1015 have not been deleted. It is analogous to @code{buffer-list} for | |
1016 buffers, and includes frames on all terminals. The list that you get is | |
1017 newly created, so modifying the list doesn't have any effect on the | |
1018 internals of Emacs. | |
1019 @end defun | |
1020 | |
1021 @defun visible-frame-list | |
1022 This function returns a list of just the currently visible frames. | |
1023 @xref{Visibility of Frames}. (Terminal frames always count as | |
1024 ``visible,'' even though only the selected one is actually displayed.) | |
1025 @end defun | |
1026 | |
1027 @defun next-frame &optional frame minibuf | |
1028 The function @code{next-frame} lets you cycle conveniently through all | |
1029 the frames on the current display from an arbitrary starting point. It | |
1030 returns the ``next'' frame after @var{frame} in the cycle. If | |
1031 @var{frame} is omitted or @code{nil}, it defaults to the selected frame | |
1032 (@pxref{Input Focus}). | |
1033 | |
1034 The second argument, @var{minibuf}, says which frames to consider: | |
1035 | |
1036 @table @asis | |
1037 @item @code{nil} | |
1038 Exclude minibuffer-only frames. | |
1039 @item @code{visible} | |
1040 Consider all visible frames. | |
1041 @item 0 | |
1042 Consider all visible or iconified frames. | |
1043 @item a window | |
1044 Consider only the frames using that particular window as their | |
1045 minibuffer. | |
1046 @item anything else | |
1047 Consider all frames. | |
1048 @end table | |
1049 @end defun | |
1050 | |
1051 @defun previous-frame &optional frame minibuf | |
1052 Like @code{next-frame}, but cycles through all frames in the opposite | |
1053 direction. | |
1054 @end defun | |
1055 | |
1056 See also @code{next-window} and @code{previous-window}, in @ref{Cyclic | |
1057 Window Ordering}. | |
1058 | |
1059 @node Frames and Windows | |
1060 @section Frames and Windows | |
1061 | |
1062 Each window is part of one and only one frame; you can get the frame | |
1063 with @code{window-frame}. | |
1064 | |
1065 @defun window-frame window | |
1066 This function returns the frame that @var{window} is on. | |
1067 @end defun | |
1068 | |
1069 All the non-minibuffer windows in a frame are arranged in a cyclic | |
1070 order. The order runs from the frame's top window, which is at the | |
1071 upper left corner, down and to the right, until it reaches the window at | |
1072 the lower right corner (always the minibuffer window, if the frame has | |
1073 one), and then it moves back to the top. @xref{Cyclic Window Ordering}. | |
1074 | |
1075 @defun frame-first-window &optional frame | |
1076 This returns the topmost, leftmost window of frame @var{frame}. | |
1077 If omitted or @code{nil}, @var{frame} defaults to the selected frame. | |
1078 @end defun | |
1079 | |
1080 At any time, exactly one window on any frame is @dfn{selected within the | |
1081 frame}. The significance of this designation is that selecting the | |
1082 frame also selects this window. You can get the frame's current | |
1083 selected window with @code{frame-selected-window}. | |
1084 | |
1085 @defun frame-selected-window &optional frame | |
1086 This function returns the window on @var{frame} that is selected | |
1087 within @var{frame}. If omitted or @code{nil}, @var{frame} defaults to | |
1088 the selected frame. | |
1089 @end defun | |
1090 | |
1091 @defun set-frame-selected-window frame window | |
1092 This sets the selected window of frame @var{frame} to @var{window}. | |
1093 If @var{frame} is @code{nil}, it operates on the selected frame. If | |
1094 @var{frame} is the selected frame, this makes @var{window} the | |
1095 selected window. This function returns @var{window}. | |
1096 @end defun | |
1097 | |
1098 Conversely, selecting a window for Emacs with @code{select-window} also | |
1099 makes that window selected within its frame. @xref{Selecting Windows}. | |
1100 | |
1101 Another function that (usually) returns one of the windows in a given | |
1102 frame is @code{minibuffer-window}. @xref{Definition of minibuffer-window}. | |
1103 | |
1104 @node Minibuffers and Frames | |
1105 @section Minibuffers and Frames | |
1106 | |
1107 Normally, each frame has its own minibuffer window at the bottom, which | |
1108 is used whenever that frame is selected. If the frame has a minibuffer, | |
1109 you can get it with @code{minibuffer-window} (@pxref{Definition of | |
1110 minibuffer-window}). | |
1111 | |
1112 However, you can also create a frame with no minibuffer. Such a frame | |
1113 must use the minibuffer window of some other frame. When you create the | |
1114 frame, you can specify explicitly the minibuffer window to use (in some | |
1115 other frame). If you don't, then the minibuffer is found in the frame | |
1116 which is the value of the variable @code{default-minibuffer-frame}. Its | |
1117 value should be a frame that does have a minibuffer. | |
1118 | |
1119 If you use a minibuffer-only frame, you might want that frame to raise | |
1120 when you enter the minibuffer. If so, set the variable | |
1121 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}. | |
1122 | |
1123 @defvar default-minibuffer-frame | |
1124 This variable specifies the frame to use for the minibuffer window, by | |
1125 default. It does not affect existing frames. It is always local to | |
1126 the current terminal and cannot be buffer-local. @xref{Multiple | |
1127 Displays}. | |
1128 @end defvar | |
1129 | |
1130 @node Input Focus | |
1131 @section Input Focus | |
1132 @cindex input focus | |
1133 @c @cindex selected frame Duplicates selected-frame | |
1134 | |
1135 At any time, one frame in Emacs is the @dfn{selected frame}. The selected | |
1136 window always resides on the selected frame. | |
1137 | |
1138 When Emacs displays its frames on several terminals (@pxref{Multiple | |
1139 Displays}), each terminal has its own selected frame. But only one of | |
1140 these is ``@emph{the} selected frame'': it's the frame that belongs to | |
1141 the terminal from which the most recent input came. That is, when Emacs | |
1142 runs a command that came from a certain terminal, the selected frame is | |
1143 the one of that terminal. Since Emacs runs only a single command at any | |
1144 given time, it needs to consider only one selected frame at a time; this | |
1145 frame is what we call @dfn{the selected frame} in this manual. The | |
1146 display on which the selected frame is displayed is the @dfn{selected | |
1147 frame's display}. | |
1148 | |
1149 @defun selected-frame | |
1150 This function returns the selected frame. | |
1151 @end defun | |
1152 | |
1153 Some window systems and window managers direct keyboard input to the | |
1154 window object that the mouse is in; others require explicit clicks or | |
1155 commands to @dfn{shift the focus} to various window objects. Either | |
1156 way, Emacs automatically keeps track of which frame has the focus. To | |
1157 switch to a different frame from a Lisp function, call | |
1158 @code{select-frame-set-input-focus}. | |
1159 | |
1160 Lisp programs can also switch frames ``temporarily'' by calling the | |
1161 function @code{select-frame}. This does not alter the window system's | |
1162 concept of focus; rather, it escapes from the window manager's control | |
1163 until that control is somehow reasserted. | |
1164 | |
1165 When using a text-only terminal, only one frame can be displayed at a | |
1166 time on the terminal, so after a call to @code{select-frame}, the next | |
1167 redisplay actually displays the newly selected frame. This frame | |
1168 remains selected until a subsequent call to @code{select-frame} or | |
1169 @code{select-frame-set-input-focus}. Each terminal frame has a number | |
1170 which appears in the mode line before the buffer name (@pxref{Mode | |
1171 Line Variables}). | |
1172 | |
1173 @defun select-frame-set-input-focus frame | |
1174 This function makes @var{frame} the selected frame, raises it (should | |
1175 it happen to be obscured by other frames) and tries to give it the X | |
1176 server's focus. On a text-only terminal, the next redisplay displays | |
1177 the new frame on the entire terminal screen. The return value of this | |
1178 function is not significant. | |
1179 @end defun | |
1180 | |
1181 @c ??? This is not yet implemented properly. | |
1182 @defun select-frame frame | |
1183 This function selects frame @var{frame}, temporarily disregarding the | |
1184 focus of the X server if any. The selection of @var{frame} lasts until | |
1185 the next time the user does something to select a different frame, or | |
1186 until the next time this function is called. (If you are using a | |
1187 window system, the previously selected frame may be restored as the | |
1188 selected frame after return to the command loop, because it still may | |
1189 have the window system's input focus.) The specified @var{frame} | |
1190 becomes the selected frame, as explained above, and the terminal that | |
1191 @var{frame} is on becomes the selected terminal. This function | |
1192 returns @var{frame}, or @code{nil} if @var{frame} has been deleted. | |
1193 | |
1194 In general, you should never use @code{select-frame} in a way that could | |
1195 switch to a different terminal without switching back when you're done. | |
1196 @end defun | |
1197 | |
1198 Emacs cooperates with the window system by arranging to select frames as | |
1199 the server and window manager request. It does so by generating a | |
1200 special kind of input event, called a @dfn{focus} event, when | |
1201 appropriate. The command loop handles a focus event by calling | |
1202 @code{handle-switch-frame}. @xref{Focus Events}. | |
1203 | |
1204 @deffn Command handle-switch-frame frame | |
1205 This function handles a focus event by selecting frame @var{frame}. | |
1206 | |
1207 Focus events normally do their job by invoking this command. | |
1208 Don't call it for any other reason. | |
1209 @end deffn | |
1210 | |
1211 @defun redirect-frame-focus frame &optional focus-frame | |
1212 This function redirects focus from @var{frame} to @var{focus-frame}. | |
1213 This means that @var{focus-frame} will receive subsequent keystrokes and | |
1214 events intended for @var{frame}. After such an event, the value of | |
1215 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame | |
1216 events specifying @var{frame} will instead select @var{focus-frame}. | |
1217 | |
1218 If @var{focus-frame} is omitted or @code{nil}, that cancels any existing | |
1219 redirection for @var{frame}, which therefore once again receives its own | |
1220 events. | |
1221 | |
1222 One use of focus redirection is for frames that don't have minibuffers. | |
1223 These frames use minibuffers on other frames. Activating a minibuffer | |
1224 on another frame redirects focus to that frame. This puts the focus on | |
1225 the minibuffer's frame, where it belongs, even though the mouse remains | |
1226 in the frame that activated the minibuffer. | |
1227 | |
1228 Selecting a frame can also change focus redirections. Selecting frame | |
1229 @code{bar}, when @code{foo} had been selected, changes any redirections | |
1230 pointing to @code{foo} so that they point to @code{bar} instead. This | |
1231 allows focus redirection to work properly when the user switches from | |
1232 one frame to another using @code{select-window}. | |
1233 | |
1234 This means that a frame whose focus is redirected to itself is treated | |
1235 differently from a frame whose focus is not redirected. | |
1236 @code{select-frame} affects the former but not the latter. | |
1237 | |
1238 The redirection lasts until @code{redirect-frame-focus} is called to | |
1239 change it. | |
1240 @end defun | |
1241 | |
1242 @defopt focus-follows-mouse | |
1243 This option is how you inform Emacs whether the window manager transfers | |
1244 focus when the user moves the mouse. Non-@code{nil} says that it does. | |
1245 When this is so, the command @code{other-frame} moves the mouse to a | |
1246 position consistent with the new selected frame. (This option has no | |
1247 effect on MS-Windows, where the mouse pointer is always automatically | |
1248 moved by the OS to the selected frame.) | |
1249 @end defopt | |
1250 | |
1251 @node Visibility of Frames | |
1252 @section Visibility of Frames | |
1253 @cindex visible frame | |
1254 @cindex invisible frame | |
1255 @cindex iconified frame | |
1256 @cindex frame visibility | |
1257 | |
1258 A window frame may be @dfn{visible}, @dfn{invisible}, or | |
1259 @dfn{iconified}. If it is visible, you can see its contents, unless | |
1260 other windows cover it. If it is iconified, the frame's contents do | |
1261 not appear on the screen, but an icon does. If the frame is | |
1262 invisible, it doesn't show on the screen, not even as an icon. | |
1263 | |
1264 Visibility is meaningless for terminal frames, since only the selected | |
1265 one is actually displayed in any case. | |
1266 | |
1267 @deffn Command make-frame-visible &optional frame | |
1268 This function makes frame @var{frame} visible. If you omit | |
1269 @var{frame}, it makes the selected frame visible. This does not raise | |
1270 the frame, but you can do that with @code{raise-frame} if you wish | |
1271 (@pxref{Raising and Lowering}). | |
1272 @end deffn | |
1273 | |
1274 @deffn Command make-frame-invisible &optional frame force | |
1275 This function makes frame @var{frame} invisible. If you omit | |
1276 @var{frame}, it makes the selected frame invisible. | |
1277 | |
1278 Unless @var{force} is non-@code{nil}, this function refuses to make | |
1279 @var{frame} invisible if all other frames are invisible.. | |
1280 @end deffn | |
1281 | |
1282 @deffn Command iconify-frame &optional frame | |
1283 This function iconifies frame @var{frame}. If you omit @var{frame}, it | |
1284 iconifies the selected frame. | |
1285 @end deffn | |
1286 | |
1287 @defun frame-visible-p frame | |
1288 This returns the visibility status of frame @var{frame}. The value is | |
1289 @code{t} if @var{frame} is visible, @code{nil} if it is invisible, and | |
1290 @code{icon} if it is iconified. | |
1291 | |
1292 On a text-only terminal, all frames are considered visible, whether | |
1293 they are currently being displayed or not, and this function returns | |
1294 @code{t} for all frames. | |
1295 @end defun | |
1296 | |
1297 The visibility status of a frame is also available as a frame | |
1298 parameter. You can read or change it as such. @xref{Management | |
1299 Parameters}. | |
1300 | |
1301 The user can iconify and deiconify frames with the window manager. | |
1302 This happens below the level at which Emacs can exert any control, but | |
1303 Emacs does provide events that you can use to keep track of such | |
1304 changes. @xref{Misc Events}. | |
1305 | |
1306 @node Raising and Lowering | |
1307 @section Raising and Lowering Frames | |
1308 | |
1309 Most window systems use a desktop metaphor. Part of this metaphor is | |
1310 the idea that windows are stacked in a notional third dimension | |
1311 perpendicular to the screen surface, and thus ordered from ``highest'' | |
1312 to ``lowest.'' Where two windows overlap, the one higher up covers | |
1313 the one underneath. Even a window at the bottom of the stack can be | |
1314 seen if no other window overlaps it. | |
1315 | |
1316 @c @cindex raising a frame redundant with raise-frame | |
1317 @cindex lowering a frame | |
1318 A window's place in this ordering is not fixed; in fact, users tend | |
1319 to change the order frequently. @dfn{Raising} a window means moving | |
1320 it ``up,'' to the top of the stack. @dfn{Lowering} a window means | |
1321 moving it to the bottom of the stack. This motion is in the notional | |
1322 third dimension only, and does not change the position of the window | |
1323 on the screen. | |
1324 | |
1325 You can raise and lower Emacs frame Windows with these functions: | |
1326 | |
1327 @deffn Command raise-frame &optional frame | |
1328 This function raises frame @var{frame} (default, the selected frame). | |
1329 If @var{frame} is invisible or iconified, this makes it visible. | |
1330 @end deffn | |
1331 | |
1332 @deffn Command lower-frame &optional frame | |
1333 This function lowers frame @var{frame} (default, the selected frame). | |
1334 @end deffn | |
1335 | |
1336 @defopt minibuffer-auto-raise | |
1337 If this is non-@code{nil}, activation of the minibuffer raises the frame | |
1338 that the minibuffer window is in. | |
1339 @end defopt | |
1340 | |
1341 You can also enable auto-raise (raising automatically when a frame is | |
1342 selected) or auto-lower (lowering automatically when it is deselected) | |
1343 for any frame using frame parameters. @xref{Management Parameters}. | |
1344 | |
1345 @node Frame Configurations | |
1346 @section Frame Configurations | |
1347 @cindex frame configuration | |
1348 | |
1349 A @dfn{frame configuration} records the current arrangement of frames, | |
1350 all their properties, and the window configuration of each one. | |
1351 (@xref{Window Configurations}.) | |
1352 | |
1353 @defun current-frame-configuration | |
1354 This function returns a frame configuration list that describes | |
1355 the current arrangement of frames and their contents. | |
1356 @end defun | |
1357 | |
1358 @defun set-frame-configuration configuration &optional nodelete | |
1359 This function restores the state of frames described in | |
1360 @var{configuration}. However, this function does not restore deleted | |
1361 frames. | |
1362 | |
1363 Ordinarily, this function deletes all existing frames not listed in | |
1364 @var{configuration}. But if @var{nodelete} is non-@code{nil}, the | |
1365 unwanted frames are iconified instead. | |
1366 @end defun | |
1367 | |
1368 @node Mouse Tracking | |
1369 @section Mouse Tracking | |
1370 @cindex mouse tracking | |
1371 @c @cindex tracking the mouse Duplicates track-mouse | |
1372 | |
1373 Sometimes it is useful to @dfn{track} the mouse, which means to display | |
1374 something to indicate where the mouse is and move the indicator as the | |
1375 mouse moves. For efficient mouse tracking, you need a way to wait until | |
1376 the mouse actually moves. | |
1377 | |
1378 The convenient way to track the mouse is to ask for events to represent | |
1379 mouse motion. Then you can wait for motion by waiting for an event. In | |
1380 addition, you can easily handle any other sorts of events that may | |
1381 occur. That is useful, because normally you don't want to track the | |
1382 mouse forever---only until some other event, such as the release of a | |
1383 button. | |
1384 | |
1385 @defspec track-mouse body@dots{} | |
1386 This special form executes @var{body}, with generation of mouse motion | |
1387 events enabled. Typically @var{body} would use @code{read-event} to | |
1388 read the motion events and modify the display accordingly. @xref{Motion | |
1389 Events}, for the format of mouse motion events. | |
1390 | |
1391 The value of @code{track-mouse} is that of the last form in @var{body}. | |
1392 You should design @var{body} to return when it sees the up-event that | |
1393 indicates the release of the button, or whatever kind of event means | |
1394 it is time to stop tracking. | |
1395 @end defspec | |
1396 | |
1397 The usual purpose of tracking mouse motion is to indicate on the screen | |
1398 the consequences of pushing or releasing a button at the current | |
1399 position. | |
1400 | |
1401 In many cases, you can avoid the need to track the mouse by using | |
1402 the @code{mouse-face} text property (@pxref{Special Properties}). | |
1403 That works at a much lower level and runs more smoothly than | |
1404 Lisp-level mouse tracking. | |
1405 | |
1406 @ignore | |
1407 @c These are not implemented yet. | |
1408 | |
1409 These functions change the screen appearance instantaneously. The | |
1410 effect is transient, only until the next ordinary Emacs redisplay. That | |
1411 is OK for mouse tracking, since it doesn't make sense for mouse tracking | |
1412 to change the text, and the body of @code{track-mouse} normally reads | |
1413 the events itself and does not do redisplay. | |
1414 | |
1415 @defun x-contour-region window beg end | |
1416 This function draws lines to make a box around the text from @var{beg} | |
1417 to @var{end}, in window @var{window}. | |
1418 @end defun | |
1419 | |
1420 @defun x-uncontour-region window beg end | |
1421 This function erases the lines that would make a box around the text | |
1422 from @var{beg} to @var{end}, in window @var{window}. Use it to remove | |
1423 a contour that you previously made by calling @code{x-contour-region}. | |
1424 @end defun | |
1425 | |
1426 @defun x-draw-rectangle frame left top right bottom | |
1427 This function draws a hollow rectangle on frame @var{frame} with the | |
1428 specified edge coordinates, all measured in pixels from the inside top | |
1429 left corner. It uses the cursor color, the one used for indicating the | |
1430 location of point. | |
1431 @end defun | |
1432 | |
1433 @defun x-erase-rectangle frame left top right bottom | |
1434 This function erases a hollow rectangle on frame @var{frame} with the | |
1435 specified edge coordinates, all measured in pixels from the inside top | |
1436 left corner. Erasure means redrawing the text and background that | |
1437 normally belong in the specified rectangle. | |
1438 @end defun | |
1439 @end ignore | |
1440 | |
1441 @node Mouse Position | |
1442 @section Mouse Position | |
1443 @cindex mouse position | |
1444 @cindex position of mouse | |
1445 | |
1446 The functions @code{mouse-position} and @code{set-mouse-position} | |
1447 give access to the current position of the mouse. | |
1448 | |
1449 @defun mouse-position | |
1450 This function returns a description of the position of the mouse. The | |
1451 value looks like @code{(@var{frame} @var{x} . @var{y})}, where @var{x} | |
1452 and @var{y} are integers giving the position in characters relative to | |
1453 the top left corner of the inside of @var{frame}. | |
1454 @end defun | |
1455 | |
1456 @defvar mouse-position-function | |
1457 If non-@code{nil}, the value of this variable is a function for | |
1458 @code{mouse-position} to call. @code{mouse-position} calls this | |
1459 function just before returning, with its normal return value as the | |
1460 sole argument, and it returns whatever this function returns to it. | |
1461 | |
1462 This abnormal hook exists for the benefit of packages like | |
1463 @file{xt-mouse.el} that need to do mouse handling at the Lisp level. | |
1464 @end defvar | |
1465 | |
1466 @defun set-mouse-position frame x y | |
1467 This function @dfn{warps the mouse} to position @var{x}, @var{y} in | |
1468 frame @var{frame}. The arguments @var{x} and @var{y} are integers, | |
1469 giving the position in characters relative to the top left corner of the | |
1470 inside of @var{frame}. If @var{frame} is not visible, this function | |
1471 does nothing. The return value is not significant. | |
1472 @end defun | |
1473 | |
1474 @defun mouse-pixel-position | |
1475 This function is like @code{mouse-position} except that it returns | |
1476 coordinates in units of pixels rather than units of characters. | |
1477 @end defun | |
1478 | |
1479 @defun set-mouse-pixel-position frame x y | |
1480 This function warps the mouse like @code{set-mouse-position} except that | |
1481 @var{x} and @var{y} are in units of pixels rather than units of | |
1482 characters. These coordinates are not required to be within the frame. | |
1483 | |
1484 If @var{frame} is not visible, this function does nothing. The return | |
1485 value is not significant. | |
1486 @end defun | |
1487 | |
1488 @need 3000 | |
1489 | |
1490 @node Pop-Up Menus | |
1491 @section Pop-Up Menus | |
1492 | |
1493 When using a window system, a Lisp program can pop up a menu so that | |
1494 the user can choose an alternative with the mouse. | |
1495 | |
1496 @defun x-popup-menu position menu | |
1497 This function displays a pop-up menu and returns an indication of | |
1498 what selection the user makes. | |
1499 | |
1500 The argument @var{position} specifies where on the screen to put the | |
1501 top left corner of the menu. It can be either a mouse button event | |
1502 (which says to put the menu where the user actuated the button) or a | |
1503 list of this form: | |
1504 | |
1505 @example | |
1506 ((@var{xoffset} @var{yoffset}) @var{window}) | |
1507 @end example | |
1508 | |
1509 @noindent | |
1510 where @var{xoffset} and @var{yoffset} are coordinates, measured in | |
1511 pixels, counting from the top left corner of @var{window}. @var{window} | |
1512 may be a window or a frame. | |
1513 | |
1514 If @var{position} is @code{t}, it means to use the current mouse | |
1515 position. If @var{position} is @code{nil}, it means to precompute the | |
1516 key binding equivalents for the keymaps specified in @var{menu}, | |
1517 without actually displaying or popping up the menu. | |
1518 | |
1519 The argument @var{menu} says what to display in the menu. It can be a | |
1520 keymap or a list of keymaps (@pxref{Menu Keymaps}). In this case, the | |
1521 return value is the list of events corresponding to the user's choice. | |
1522 (This list has more than one element if the choice occurred in a | |
1523 submenu.) Note that @code{x-popup-menu} does not actually execute the | |
1524 command bound to that sequence of events. | |
1525 | |
1526 Alternatively, @var{menu} can have the following form: | |
1527 | |
1528 @example | |
1529 (@var{title} @var{pane1} @var{pane2}...) | |
1530 @end example | |
1531 | |
1532 @noindent | |
1533 where each pane is a list of form | |
1534 | |
1535 @example | |
1536 (@var{title} @var{item1} @var{item2}...) | |
1537 @end example | |
1538 | |
1539 Each item should normally be a cons cell @code{(@var{line} . @var{value})}, | |
1540 where @var{line} is a string, and @var{value} is the value to return if | |
1541 that @var{line} is chosen. An item can also be a string; this makes a | |
1542 non-selectable line in the menu. | |
1543 | |
1544 If the user gets rid of the menu without making a valid choice, for | |
1545 instance by clicking the mouse away from a valid choice or by typing | |
1546 keyboard input, then this normally results in a quit and | |
1547 @code{x-popup-menu} does not return. But if @var{position} is a mouse | |
1548 button event (indicating that the user invoked the menu with the | |
1549 mouse) then no quit occurs and @code{x-popup-menu} returns @code{nil}. | |
1550 @end defun | |
1551 | |
1552 @strong{Usage note:} Don't use @code{x-popup-menu} to display a menu | |
1553 if you could do the job with a prefix key defined with a menu keymap. | |
1554 If you use a menu keymap to implement a menu, @kbd{C-h c} and @kbd{C-h | |
1555 a} can see the individual items in that menu and provide help for them. | |
1556 If instead you implement the menu by defining a command that calls | |
1557 @code{x-popup-menu}, the help facilities cannot know what happens inside | |
1558 that command, so they cannot give any help for the menu's items. | |
1559 | |
1560 The menu bar mechanism, which lets you switch between submenus by | |
1561 moving the mouse, cannot look within the definition of a command to see | |
1562 that it calls @code{x-popup-menu}. Therefore, if you try to implement a | |
1563 submenu using @code{x-popup-menu}, it cannot work with the menu bar in | |
1564 an integrated fashion. This is why all menu bar submenus are | |
1565 implemented with menu keymaps within the parent menu, and never with | |
1566 @code{x-popup-menu}. @xref{Menu Bar}. | |
1567 | |
1568 If you want a menu bar submenu to have contents that vary, you should | |
1569 still use a menu keymap to implement it. To make the contents vary, add | |
1570 a hook function to @code{menu-bar-update-hook} to update the contents of | |
1571 the menu keymap as necessary. | |
1572 | |
1573 @node Dialog Boxes | |
1574 @section Dialog Boxes | |
1575 @cindex dialog boxes | |
1576 | |
1577 A dialog box is a variant of a pop-up menu---it looks a little | |
1578 different, it always appears in the center of a frame, and it has just | |
1579 one level and one or more buttons. The main use of dialog boxes is | |
1580 for asking questions that the user can answer with ``yes,'' ``no,'' | |
1581 and a few other alternatives. With a single button, they can also | |
1582 force the user to acknowledge important information. The functions | |
1583 @code{y-or-n-p} and @code{yes-or-no-p} use dialog boxes instead of the | |
1584 keyboard, when called from commands invoked by mouse clicks. | |
1585 | |
1586 @defun x-popup-dialog position contents &optional header | |
1587 This function displays a pop-up dialog box and returns an indication of | |
1588 what selection the user makes. The argument @var{contents} specifies | |
1589 the alternatives to offer; it has this format: | |
1590 | |
1591 @example | |
1592 (@var{title} (@var{string} . @var{value})@dots{}) | |
1593 @end example | |
1594 | |
1595 @noindent | |
1596 which looks like the list that specifies a single pane for | |
1597 @code{x-popup-menu}. | |
1598 | |
1599 The return value is @var{value} from the chosen alternative. | |
1600 | |
1601 As for @code{x-popup-menu}, an element of the list may be just a | |
1602 string instead of a cons cell @code{(@var{string} . @var{value})}. | |
1603 That makes a box that cannot be selected. | |
1604 | |
1605 If @code{nil} appears in the list, it separates the left-hand items from | |
1606 the right-hand items; items that precede the @code{nil} appear on the | |
1607 left, and items that follow the @code{nil} appear on the right. If you | |
1608 don't include a @code{nil} in the list, then approximately half the | |
1609 items appear on each side. | |
1610 | |
1611 Dialog boxes always appear in the center of a frame; the argument | |
1612 @var{position} specifies which frame. The possible values are as in | |
1613 @code{x-popup-menu}, but the precise coordinates or the individual | |
1614 window don't matter; only the frame matters. | |
1615 | |
1616 If @var{header} is non-@code{nil}, the frame title for the box is | |
1617 @samp{Information}, otherwise it is @samp{Question}. The former is used | |
1618 for @code{message-box} (@pxref{message-box}). | |
1619 | |
1620 In some configurations, Emacs cannot display a real dialog box; so | |
1621 instead it displays the same items in a pop-up menu in the center of the | |
1622 frame. | |
1623 | |
1624 If the user gets rid of the dialog box without making a valid choice, | |
1625 for instance using the window manager, then this produces a quit and | |
1626 @code{x-popup-dialog} does not return. | |
1627 @end defun | |
1628 | |
1629 @node Pointer Shape | |
1630 @section Pointer Shape | |
1631 @cindex pointer shape | |
1632 @cindex mouse pointer shape | |
1633 | |
1634 You can specify the mouse pointer style for particular text or | |
1635 images using the @code{pointer} text property, and for images with the | |
1636 @code{:pointer} and @code{:map} image properties. The values you can | |
1637 use in these properties are @code{text} (or @code{nil}), @code{arrow}, | |
1638 @code{hand}, @code{vdrag}, @code{hdrag}, @code{modeline}, and | |
1639 @code{hourglass}. @code{text} stands for the usual mouse pointer | |
1640 style used over text. | |
1641 | |
1642 Over void parts of the window (parts that do not correspond to any | |
1643 of the buffer contents), the mouse pointer usually uses the | |
1644 @code{arrow} style, but you can specify a different style (one of | |
1645 those above) by setting @code{void-text-area-pointer}. | |
1646 | |
1647 @defvar void-text-area-pointer | |
1648 This variable specifies the mouse pointer style for void text areas. | |
1649 These include the areas after the end of a line or below the last line | |
1650 in the buffer. The default is to use the @code{arrow} (non-text) | |
1651 pointer style. | |
1652 @end defvar | |
1653 | |
1654 You can specify what the @code{text} pointer style really looks like | |
1655 by setting the variable @code{x-pointer-shape}. | |
1656 | |
1657 @defvar x-pointer-shape | |
1658 This variable specifies the pointer shape to use ordinarily in the | |
1659 Emacs frame, for the @code{text} pointer style. | |
1660 @end defvar | |
1661 | |
1662 @defvar x-sensitive-text-pointer-shape | |
1663 This variable specifies the pointer shape to use when the mouse | |
1664 is over mouse-sensitive text. | |
1665 @end defvar | |
1666 | |
1667 These variables affect newly created frames. They do not normally | |
1668 affect existing frames; however, if you set the mouse color of a | |
1669 frame, that also installs the current value of those two variables. | |
1670 @xref{Color Parameters}. | |
1671 | |
1672 The values you can use, to specify either of these pointer shapes, are | |
1673 defined in the file @file{lisp/term/x-win.el}. Use @kbd{M-x apropos | |
1674 @key{RET} x-pointer @key{RET}} to see a list of them. | |
1675 | |
1676 @node Window System Selections | |
1677 @section Window System Selections | |
1678 @cindex selection (for window systems) | |
1679 | |
1680 The X server records a set of @dfn{selections} which permit transfer of | |
1681 data between application programs. The various selections are | |
1682 distinguished by @dfn{selection types}, represented in Emacs by | |
1683 symbols. X clients including Emacs can read or set the selection for | |
1684 any given type. | |
1685 | |
1686 @deffn Command x-set-selection type data | |
1687 This function sets a ``selection'' in the X server. It takes two | |
1688 arguments: a selection type @var{type}, and the value to assign to it, | |
1689 @var{data}. If @var{data} is @code{nil}, it means to clear out the | |
1690 selection. Otherwise, @var{data} may be a string, a symbol, an integer | |
1691 (or a cons of two integers or list of two integers), an overlay, or a | |
1692 cons of two markers pointing to the same buffer. An overlay or a pair | |
1693 of markers stands for text in the overlay or between the markers. | |
1694 | |
1695 The argument @var{data} may also be a vector of valid non-vector | |
1696 selection values. | |
1697 | |
1698 Each possible @var{type} has its own selection value, which changes | |
1699 independently. The usual values of @var{type} are @code{PRIMARY}, | |
1700 @code{SECONDARY} and @code{CLIPBOARD}; these are symbols with upper-case | |
1701 names, in accord with X Window System conventions. If @var{type} is | |
1702 @code{nil}, that stands for @code{PRIMARY}. | |
1703 | |
1704 This function returns @var{data}. | |
1705 @end deffn | |
1706 | |
1707 @defun x-get-selection &optional type data-type | |
1708 This function accesses selections set up by Emacs or by other X | |
1709 clients. It takes two optional arguments, @var{type} and | |
1710 @var{data-type}. The default for @var{type}, the selection type, is | |
1711 @code{PRIMARY}. | |
1712 | |
1713 The @var{data-type} argument specifies the form of data conversion to | |
1714 use, to convert the raw data obtained from another X client into Lisp | |
1715 data. Meaningful values include @code{TEXT}, @code{STRING}, | |
1716 @code{UTF8_STRING}, @code{TARGETS}, @code{LENGTH}, @code{DELETE}, | |
1717 @code{FILE_NAME}, @code{CHARACTER_POSITION}, @code{NAME}, | |
1718 @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, @code{OWNER_OS}, | |
1719 @code{HOST_NAME}, @code{USER}, @code{CLASS}, @code{ATOM}, and | |
1720 @code{INTEGER}. (These are symbols with upper-case names in accord | |
1721 with X conventions.) The default for @var{data-type} is | |
1722 @code{STRING}. | |
1723 @end defun | |
1724 | |
1725 @cindex cut buffer | |
1726 The X server also has a set of eight numbered @dfn{cut buffers} which can | |
1727 store text or other data being moved between applications. Cut buffers | |
1728 are considered obsolete, but Emacs supports them for the sake of X | |
1729 clients that still use them. Cut buffers are numbered from 0 to 7. | |
1730 | |
1731 @defun x-get-cut-buffer &optional n | |
1732 This function returns the contents of cut buffer number @var{n}. | |
1733 If omitted @var{n} defaults to 0. | |
1734 @end defun | |
1735 | |
1736 @defun x-set-cut-buffer string &optional push | |
1737 @anchor{Definition of x-set-cut-buffer} | |
1738 This function stores @var{string} into the first cut buffer (cut buffer | |
1739 0). If @var{push} is @code{nil}, only the first cut buffer is changed. | |
1740 If @var{push} is non-@code{nil}, that says to move the values down | |
1741 through the series of cut buffers, much like the way successive kills in | |
1742 Emacs move down the kill ring. In other words, the previous value of | |
1743 the first cut buffer moves into the second cut buffer, and the second to | |
1744 the third, and so on through all eight cut buffers. | |
1745 @end defun | |
1746 | |
1747 @defvar selection-coding-system | |
1748 This variable specifies the coding system to use when reading and | |
1749 writing selections or the clipboard. @xref{Coding | |
1750 Systems}. The default is @code{compound-text-with-extensions}, which | |
1751 converts to the text representation that X11 normally uses. | |
1752 @end defvar | |
1753 | |
1754 @cindex clipboard support (for MS-Windows) | |
1755 When Emacs runs on MS-Windows, it does not implement X selections in | |
1756 general, but it does support the clipboard. @code{x-get-selection} | |
1757 and @code{x-set-selection} on MS-Windows support the text data type | |
1758 only; if the clipboard holds other types of data, Emacs treats the | |
1759 clipboard as empty. | |
1760 | |
1761 @defopt x-select-enable-clipboard | |
1762 If this is non-@code{nil}, the Emacs yank functions consult the | |
1763 clipboard before the primary selection, and the kill functions store in | |
1764 the clipboard as well as the primary selection. Otherwise they do not | |
1765 access the clipboard at all. The default is @code{nil} on most systems, | |
97043
9592c50233ab
Remove support for Mac Carbon.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
92098
diff
changeset
|
1766 but @code{t} on MS-Windows. |
84068 | 1767 @end defopt |
1768 | |
1769 @node Drag and Drop | |
1770 @section Drag and Drop | |
1771 | |
1772 @vindex x-dnd-test-function | |
1773 @vindex x-dnd-known-types | |
1774 When a user drags something from another application over Emacs, that other | |
1775 application expects Emacs to tell it if Emacs can handle the data that is | |
1776 dragged. The variable @code{x-dnd-test-function} is used by Emacs to determine | |
1777 what to reply. The default value is @code{x-dnd-default-test-function} | |
1778 which accepts drops if the type of the data to be dropped is present in | |
1779 @code{x-dnd-known-types}. You can customize @code{x-dnd-test-function} and/or | |
1780 @code{x-dnd-known-types} if you want Emacs to accept or reject drops based | |
1781 on some other criteria. | |
1782 | |
1783 @vindex x-dnd-types-alist | |
1784 If you want to change the way Emacs handles drop of different types | |
1785 or add a new type, customize @code{x-dnd-types-alist}. This requires | |
1786 detailed knowledge of what types other applications use for drag and | |
1787 drop. | |
1788 | |
1789 @vindex dnd-protocol-alist | |
1790 When an URL is dropped on Emacs it may be a file, but it may also be | |
1791 another URL type (ftp, http, etc.). Emacs first checks | |
1792 @code{dnd-protocol-alist} to determine what to do with the URL. If | |
1793 there is no match there and if @code{browse-url-browser-function} is | |
1794 an alist, Emacs looks for a match there. If no match is found the | |
1795 text for the URL is inserted. If you want to alter Emacs behavior, | |
1796 you can customize these variables. | |
1797 | |
1798 @node Color Names | |
1799 @section Color Names | |
1800 | |
1801 @cindex color names | |
1802 @cindex specify color | |
1803 @cindex numerical RGB color specification | |
1804 A color name is text (usually in a string) that specifies a color. | |
1805 Symbolic names such as @samp{black}, @samp{white}, @samp{red}, etc., | |
1806 are allowed; use @kbd{M-x list-colors-display} to see a list of | |
1807 defined names. You can also specify colors numerically in forms such | |
1808 as @samp{#@var{rgb}} and @samp{RGB:@var{r}/@var{g}/@var{b}}, where | |
1809 @var{r} specifies the red level, @var{g} specifies the green level, | |
1810 and @var{b} specifies the blue level. You can use either one, two, | |
1811 three, or four hex digits for @var{r}; then you must use the same | |
1812 number of hex digits for all @var{g} and @var{b} as well, making | |
1813 either 3, 6, 9 or 12 hex digits in all. (See the documentation of the | |
1814 X Window System for more details about numerical RGB specification of | |
1815 colors.) | |
1816 | |
1817 These functions provide a way to determine which color names are | |
1818 valid, and what they look like. In some cases, the value depends on the | |
1819 @dfn{selected frame}, as described below; see @ref{Input Focus}, for the | |
1820 meaning of the term ``selected frame.'' | |
1821 | |
98969
5919c911fb16
(Color Names): Add an xref to `read-color'.
Eli Zaretskii <eliz@gnu.org>
parents:
98755
diff
changeset
|
1822 To read user input of color names with completion, use |
5919c911fb16
(Color Names): Add an xref to `read-color'.
Eli Zaretskii <eliz@gnu.org>
parents:
98755
diff
changeset
|
1823 @code{read-color} (@pxref{High-Level Completion, read-color}). |
5919c911fb16
(Color Names): Add an xref to `read-color'.
Eli Zaretskii <eliz@gnu.org>
parents:
98755
diff
changeset
|
1824 |
84068 | 1825 @defun color-defined-p color &optional frame |
1826 This function reports whether a color name is meaningful. It returns | |
1827 @code{t} if so; otherwise, @code{nil}. The argument @var{frame} says | |
1828 which frame's display to ask about; if @var{frame} is omitted or | |
1829 @code{nil}, the selected frame is used. | |
1830 | |
1831 Note that this does not tell you whether the display you are using | |
1832 really supports that color. When using X, you can ask for any defined | |
1833 color on any kind of display, and you will get some result---typically, | |
1834 the closest it can do. To determine whether a frame can really display | |
1835 a certain color, use @code{color-supported-p} (see below). | |
1836 | |
1837 @findex x-color-defined-p | |
1838 This function used to be called @code{x-color-defined-p}, | |
1839 and that name is still supported as an alias. | |
1840 @end defun | |
1841 | |
1842 @defun defined-colors &optional frame | |
1843 This function returns a list of the color names that are defined | |
1844 and supported on frame @var{frame} (default, the selected frame). | |
1845 If @var{frame} does not support colors, the value is @code{nil}. | |
1846 | |
1847 @findex x-defined-colors | |
1848 This function used to be called @code{x-defined-colors}, | |
1849 and that name is still supported as an alias. | |
1850 @end defun | |
1851 | |
1852 @defun color-supported-p color &optional frame background-p | |
1853 This returns @code{t} if @var{frame} can really display the color | |
1854 @var{color} (or at least something close to it). If @var{frame} is | |
1855 omitted or @code{nil}, the question applies to the selected frame. | |
1856 | |
1857 Some terminals support a different set of colors for foreground and | |
1858 background. If @var{background-p} is non-@code{nil}, that means you are | |
1859 asking whether @var{color} can be used as a background; otherwise you | |
1860 are asking whether it can be used as a foreground. | |
1861 | |
1862 The argument @var{color} must be a valid color name. | |
1863 @end defun | |
1864 | |
1865 @defun color-gray-p color &optional frame | |
1866 This returns @code{t} if @var{color} is a shade of gray, as defined on | |
1867 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, the | |
1868 question applies to the selected frame. If @var{color} is not a valid | |
1869 color name, this function returns @code{nil}. | |
1870 @end defun | |
1871 | |
1872 @defun color-values color &optional frame | |
1873 @cindex rgb value | |
1874 This function returns a value that describes what @var{color} should | |
1875 ideally look like on @var{frame}. If @var{color} is defined, the | |
1876 value is a list of three integers, which give the amount of red, the | |
1877 amount of green, and the amount of blue. Each integer ranges in | |
1878 principle from 0 to 65535, but some displays may not use the full | |
1879 range. This three-element list is called the @dfn{rgb values} of the | |
1880 color. | |
1881 | |
1882 If @var{color} is not defined, the value is @code{nil}. | |
1883 | |
1884 @example | |
1885 (color-values "black") | |
1886 @result{} (0 0 0) | |
1887 (color-values "white") | |
1888 @result{} (65280 65280 65280) | |
1889 (color-values "red") | |
1890 @result{} (65280 0 0) | |
1891 (color-values "pink") | |
1892 @result{} (65280 49152 51968) | |
1893 (color-values "hungry") | |
1894 @result{} nil | |
1895 @end example | |
1896 | |
1897 The color values are returned for @var{frame}'s display. If | |
1898 @var{frame} is omitted or @code{nil}, the information is returned for | |
1899 the selected frame's display. If the frame cannot display colors, the | |
1900 value is @code{nil}. | |
1901 | |
1902 @findex x-color-values | |
1903 This function used to be called @code{x-color-values}, | |
1904 and that name is still supported as an alias. | |
1905 @end defun | |
1906 | |
1907 @node Text Terminal Colors | |
1908 @section Text Terminal Colors | |
1909 @cindex colors on text-only terminals | |
1910 | |
1911 Text-only terminals usually support only a small number of colors, | |
1912 and the computer uses small integers to select colors on the terminal. | |
1913 This means that the computer cannot reliably tell what the selected | |
1914 color looks like; instead, you have to inform your application which | |
1915 small integers correspond to which colors. However, Emacs does know | |
1916 the standard set of colors and will try to use them automatically. | |
1917 | |
1918 The functions described in this section control how terminal colors | |
1919 are used by Emacs. | |
1920 | |
1921 Several of these functions use or return @dfn{rgb values}, described | |
1922 in @ref{Color Names}. | |
1923 | |
1924 These functions accept a display (either a frame or the name of a | |
1925 terminal) as an optional argument. We hope in the future to make Emacs | |
1926 support more than one text-only terminal at one time; then this argument | |
1927 will specify which terminal to operate on (the default being the | |
1928 selected frame's terminal; @pxref{Input Focus}). At present, though, | |
1929 the @var{frame} argument has no effect. | |
1930 | |
1931 @defun tty-color-define name number &optional rgb frame | |
1932 This function associates the color name @var{name} with | |
1933 color number @var{number} on the terminal. | |
1934 | |
1935 The optional argument @var{rgb}, if specified, is an rgb value, a list | |
1936 of three numbers that specify what the color actually looks like. | |
1937 If you do not specify @var{rgb}, then this color cannot be used by | |
1938 @code{tty-color-approximate} to approximate other colors, because | |
1939 Emacs will not know what it looks like. | |
1940 @end defun | |
1941 | |
1942 @defun tty-color-clear &optional frame | |
1943 This function clears the table of defined colors for a text-only terminal. | |
1944 @end defun | |
1945 | |
1946 @defun tty-color-alist &optional frame | |
1947 This function returns an alist recording the known colors supported by a | |
1948 text-only terminal. | |
1949 | |
1950 Each element has the form @code{(@var{name} @var{number} . @var{rgb})} | |
1951 or @code{(@var{name} @var{number})}. Here, @var{name} is the color | |
1952 name, @var{number} is the number used to specify it to the terminal. | |
1953 If present, @var{rgb} is a list of three color values (for red, green, | |
1954 and blue) that says what the color actually looks like. | |
1955 @end defun | |
1956 | |
1957 @defun tty-color-approximate rgb &optional frame | |
1958 This function finds the closest color, among the known colors | |
1959 supported for @var{display}, to that described by the rgb value | |
1960 @var{rgb} (a list of color values). The return value is an element of | |
1961 @code{tty-color-alist}. | |
1962 @end defun | |
1963 | |
1964 @defun tty-color-translate color &optional frame | |
1965 This function finds the closest color to @var{color} among the known | |
1966 colors supported for @var{display} and returns its index (an integer). | |
1967 If the name @var{color} is not defined, the value is @code{nil}. | |
1968 @end defun | |
1969 | |
1970 @node Resources | |
1971 @section X Resources | |
1972 | |
1973 @defun x-get-resource attribute class &optional component subclass | |
1974 The function @code{x-get-resource} retrieves a resource value from the X | |
1975 Window defaults database. | |
1976 | |
1977 Resources are indexed by a combination of a @dfn{key} and a @dfn{class}. | |
1978 This function searches using a key of the form | |
1979 @samp{@var{instance}.@var{attribute}} (where @var{instance} is the name | |
1980 under which Emacs was invoked), and using @samp{Emacs.@var{class}} as | |
1981 the class. | |
1982 | |
1983 The optional arguments @var{component} and @var{subclass} add to the key | |
1984 and the class, respectively. You must specify both of them or neither. | |
1985 If you specify them, the key is | |
1986 @samp{@var{instance}.@var{component}.@var{attribute}}, and the class is | |
1987 @samp{Emacs.@var{class}.@var{subclass}}. | |
1988 @end defun | |
1989 | |
1990 @defvar x-resource-class | |
1991 This variable specifies the application name that @code{x-get-resource} | |
1992 should look up. The default value is @code{"Emacs"}. You can examine X | |
1993 resources for application names other than ``Emacs'' by binding this | |
1994 variable to some other string, around a call to @code{x-get-resource}. | |
1995 @end defvar | |
1996 | |
1997 @defvar x-resource-name | |
1998 This variable specifies the instance name that @code{x-get-resource} | |
1999 should look up. The default value is the name Emacs was invoked with, | |
2000 or the value specified with the @samp{-name} or @samp{-rn} switches. | |
2001 @end defvar | |
2002 | |
2003 To illustrate some of the above, suppose that you have the line: | |
2004 | |
2005 @example | |
2006 xterm.vt100.background: yellow | |
2007 @end example | |
2008 | |
2009 @noindent | |
2010 in your X resources file (whose name is usually @file{~/.Xdefaults} | |
2011 or @file{~/.Xresources}). Then: | |
2012 | |
2013 @example | |
2014 @group | |
2015 (let ((x-resource-class "XTerm") (x-resource-name "xterm")) | |
2016 (x-get-resource "vt100.background" "VT100.Background")) | |
2017 @result{} "yellow" | |
2018 @end group | |
2019 @group | |
2020 (let ((x-resource-class "XTerm") (x-resource-name "xterm")) | |
2021 (x-get-resource "background" "VT100" "vt100" "Background")) | |
2022 @result{} "yellow" | |
2023 @end group | |
2024 @end example | |
2025 | |
2026 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}. | |
2027 | |
2028 @node Display Feature Testing | |
2029 @section Display Feature Testing | |
2030 @cindex display feature testing | |
2031 | |
2032 The functions in this section describe the basic capabilities of a | |
2033 particular display. Lisp programs can use them to adapt their behavior | |
2034 to what the display can do. For example, a program that ordinarily uses | |
2035 a popup menu could use the minibuffer if popup menus are not supported. | |
2036 | |
2037 The optional argument @var{display} in these functions specifies which | |
2038 display to ask the question about. It can be a display name, a frame | |
2039 (which designates the display that frame is on), or @code{nil} (which | |
2040 refers to the selected frame's display, @pxref{Input Focus}). | |
2041 | |
2042 @xref{Color Names}, @ref{Text Terminal Colors}, for other functions to | |
2043 obtain information about displays. | |
2044 | |
2045 @defun display-popup-menus-p &optional display | |
2046 This function returns @code{t} if popup menus are supported on | |
2047 @var{display}, @code{nil} if not. Support for popup menus requires that | |
2048 the mouse be available, since the user cannot choose menu items without | |
2049 a mouse. | |
2050 @end defun | |
2051 | |
2052 @defun display-graphic-p &optional display | |
2053 This function returns @code{t} if @var{display} is a graphic display | |
2054 capable of displaying several frames and several different fonts at | |
2055 once. This is true for displays that use a window system such as X, and | |
2056 false for text-only terminals. | |
2057 @end defun | |
2058 | |
2059 @defun display-mouse-p &optional display | |
2060 @cindex mouse, availability | |
2061 This function returns @code{t} if @var{display} has a mouse available, | |
2062 @code{nil} if not. | |
2063 @end defun | |
2064 | |
2065 @defun display-color-p &optional display | |
2066 @findex x-display-color-p | |
2067 This function returns @code{t} if the screen is a color screen. | |
2068 It used to be called @code{x-display-color-p}, and that name | |
2069 is still supported as an alias. | |
2070 @end defun | |
2071 | |
2072 @defun display-grayscale-p &optional display | |
2073 This function returns @code{t} if the screen can display shades of gray. | |
2074 (All color displays can do this.) | |
2075 @end defun | |
2076 | |
2077 @defun display-supports-face-attributes-p attributes &optional display | |
2078 @anchor{Display Face Attribute Testing} | |
2079 This function returns non-@code{nil} if all the face attributes in | |
2080 @var{attributes} are supported (@pxref{Face Attributes}). | |
2081 | |
2082 The definition of `supported' is somewhat heuristic, but basically | |
2083 means that a face containing all the attributes in @var{attributes}, | |
2084 when merged with the default face for display, can be represented in a | |
2085 way that's | |
2086 | |
2087 @enumerate | |
2088 @item | |
2089 different in appearance than the default face, and | |
2090 | |
2091 @item | |
2092 `close in spirit' to what the attributes specify, if not exact. | |
2093 @end enumerate | |
2094 | |
2095 Point (2) implies that a @code{:weight black} attribute will be | |
2096 satisfied by any display that can display bold, as will | |
2097 @code{:foreground "yellow"} as long as some yellowish color can be | |
2098 displayed, but @code{:slant italic} will @emph{not} be satisfied by | |
2099 the tty display code's automatic substitution of a `dim' face for | |
2100 italic. | |
2101 @end defun | |
2102 | |
2103 @defun display-selections-p &optional display | |
2104 This function returns @code{t} if @var{display} supports selections. | |
2105 Windowed displays normally support selections, but they may also be | |
2106 supported in some other cases. | |
2107 @end defun | |
2108 | |
2109 @defun display-images-p &optional display | |
2110 This function returns @code{t} if @var{display} can display images. | |
2111 Windowed displays ought in principle to handle images, but some | |
2112 systems lack the support for that. On a display that does not support | |
2113 images, Emacs cannot display a tool bar. | |
2114 @end defun | |
2115 | |
2116 @defun display-screens &optional display | |
2117 This function returns the number of screens associated with the display. | |
2118 @end defun | |
2119 | |
2120 @defun display-pixel-height &optional display | |
2121 This function returns the height of the screen in pixels. | |
2122 On a character terminal, it gives the height in characters. | |
2123 | |
2124 For graphical terminals, note that on ``multi-monitor'' setups this | |
2125 refers to the pixel width for all physical monitors associated with | |
2126 @var{display}. @xref{Multiple Displays}. | |
2127 @end defun | |
2128 | |
2129 @defun display-pixel-width &optional display | |
2130 This function returns the width of the screen in pixels. | |
2131 On a character terminal, it gives the width in characters. | |
2132 | |
2133 For graphical terminals, note that on ``multi-monitor'' setups this | |
2134 refers to the pixel width for all physical monitors associated with | |
2135 @var{display}. @xref{Multiple Displays}. | |
2136 @end defun | |
2137 | |
2138 @defun display-mm-height &optional display | |
2139 This function returns the height of the screen in millimeters, | |
2140 or @code{nil} if Emacs cannot get that information. | |
2141 @end defun | |
2142 | |
2143 @defun display-mm-width &optional display | |
2144 This function returns the width of the screen in millimeters, | |
2145 or @code{nil} if Emacs cannot get that information. | |
2146 @end defun | |
2147 | |
2148 @defvar display-mm-dimensions-alist | |
2149 This variable allows the user to specify the dimensions of graphical | |
2150 displays returned by @code{display-mm-height} and | |
2151 @code{display-mm-width} in case the system provides incorrect values. | |
2152 @end defvar | |
2153 | |
2154 @defun display-backing-store &optional display | |
2155 This function returns the backing store capability of the display. | |
2156 Backing store means recording the pixels of windows (and parts of | |
2157 windows) that are not exposed, so that when exposed they can be | |
2158 displayed very quickly. | |
2159 | |
2160 Values can be the symbols @code{always}, @code{when-mapped}, or | |
2161 @code{not-useful}. The function can also return @code{nil} | |
2162 when the question is inapplicable to a certain kind of display. | |
2163 @end defun | |
2164 | |
2165 @defun display-save-under &optional display | |
2166 This function returns non-@code{nil} if the display supports the | |
2167 SaveUnder feature. That feature is used by pop-up windows | |
2168 to save the pixels they obscure, so that they can pop down | |
2169 quickly. | |
2170 @end defun | |
2171 | |
2172 @defun display-planes &optional display | |
2173 This function returns the number of planes the display supports. | |
2174 This is typically the number of bits per pixel. | |
2175 For a tty display, it is log to base two of the number of colors supported. | |
2176 @end defun | |
2177 | |
2178 @defun display-visual-class &optional display | |
2179 This function returns the visual class for the screen. The value is one | |
2180 of the symbols @code{static-gray}, @code{gray-scale}, | |
2181 @code{static-color}, @code{pseudo-color}, @code{true-color}, and | |
2182 @code{direct-color}. | |
2183 @end defun | |
2184 | |
2185 @defun display-color-cells &optional display | |
2186 This function returns the number of color cells the screen supports. | |
2187 @end defun | |
2188 | |
2189 These functions obtain additional information specifically | |
2190 about X displays. | |
2191 | |
2192 @defun x-server-version &optional display | |
2193 This function returns the list of version numbers of the X server | |
2194 running the display. The value is a list of three integers: the major | |
2195 and minor version numbers of the X protocol, and the | |
2196 distributor-specific release number of the X server software itself. | |
2197 @end defun | |
2198 | |
2199 @defun x-server-vendor &optional display | |
2200 This function returns the ``vendor'' that provided the X server | |
2201 software (as a string). Really this means whoever distributes the X | |
2202 server. | |
2203 | |
2204 When the developers of X labelled software distributors as | |
2205 ``vendors,'' they showed their false assumption that no system could | |
2206 ever be developed and distributed noncommercially. | |
2207 @end defun | |
2208 | |
2209 @ignore | |
2210 @defvar x-no-window-manager | |
2211 This variable's value is @code{t} if no X window manager is in use. | |
2212 @end defvar | |
2213 @end ignore | |
2214 | |
2215 @ignore | |
2216 @item | |
2217 The functions @code{x-pixel-width} and @code{x-pixel-height} return the | |
2218 width and height of an X Window frame, measured in pixels. | |
2219 @end ignore | |
2220 | |
2221 @ignore | |
2222 arch-tag: 94977df6-3dca-4730-b57b-c6329e9282ba | |
2223 @end ignore |