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