Mercurial > emacs
annotate lispref/frames.texi @ 47044:c3fb9620c314
2002-08-25 Andrew Choi <akochoi@shaw.ca>
* emacs.c (main): Call init_mac_osx_environment if HAVE_CARBON is
defined instead of MAC_OSX.
[Already logged in src/ChangeLog]
author | Andrew Choi <akochoi@shaw.ca> |
---|---|
date | Tue, 27 Aug 2002 00:30:54 +0000 |
parents | 08e62ca55f2c |
children | 6469b390d805 |
rev | line source |
---|---|
6547 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
45744
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2002 |
27189 | 4 @c Free Software Foundation, Inc. |
6547 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/frames | |
7 @node Frames, Positions, Windows, Top | |
8 @chapter Frames | |
9 @cindex frame | |
10 | |
13155
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
11 A @dfn{frame} is a rectangle on the screen that contains one or more |
6547 | 12 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
|
13 perhaps a minibuffer window), which you can subdivide vertically or |
6547 | 14 horizontally into smaller windows. |
15 | |
16 @cindex terminal frame | |
12067 | 17 When Emacs runs on a text-only terminal, it starts with one |
12125
995be67f3fd1
updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
18 @dfn{terminal frame}. If you create additional ones, Emacs displays |
12067 | 19 one and only one at any given time---on the terminal screen, of course. |
20 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
21 @cindex window frame |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
22 When Emacs communicates directly with a supported window system, such |
35476 | 23 as X, it does not have a terminal frame; instead, it starts with |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
24 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
|
25 display several such frames at once as is usual for window systems. |
6547 | 26 |
27 @defun framep object | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
28 This predicate returns a non-@code{nil} value if @var{object} is a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
29 frame, and @code{nil} otherwise. For a frame, the value indicates which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
30 kind of display the frame uses: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
31 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
32 @table @code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
33 @item x |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
34 The frame is displayed in an X window. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
35 @item t |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
36 A terminal frame on a character display. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
37 @item mac |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
38 The frame is displayed on a Macintosh. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
39 @item w32 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
40 The frame is displayed on MS-Windows 9X/NT. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
41 @item pc |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
42 The frame is displayed on an MS-DOS terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
43 @end table |
6547 | 44 @end defun |
45 | |
46 @menu | |
12067 | 47 * Creating Frames:: Creating additional frames. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
48 * Multiple Displays:: Creating frames on other displays. |
6547 | 49 * Frame Parameters:: Controlling frame size, position, font, etc. |
12067 | 50 * Frame Titles:: Automatic updating of frame titles. |
6547 | 51 * Deleting Frames:: Frames last until explicitly deleted. |
52 * Finding All Frames:: How to examine all existing frames. | |
53 * Frames and Windows:: A frame contains windows; | |
54 display of text always works through windows. | |
55 * Minibuffers and Frames:: How a frame finds the minibuffer to use. | |
56 * Input Focus:: Specifying the selected frame. | |
57 * 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
|
58 * Raising and Lowering:: Raising a frame makes it hide other windows; |
6547 | 59 lowering it makes the others hide them. |
60 * Frame Configurations:: Saving the state of all frames. | |
61 * Mouse Tracking:: Getting events that say when the mouse moves. | |
62 * Mouse Position:: Asking where the mouse is, or moving it. | |
63 * Pop-Up Menus:: Displaying a menu for the user to select from. | |
64 * 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
|
65 * Pointer Shapes:: Specifying the shape of the mouse pointer. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
66 * Window System Selections:: Transferring text to and from other X clients. |
12098 | 67 * Color Names:: Getting the definitions of color names. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
68 * Text Terminal Colors:: Defining colors for text-only terminals. |
6547 | 69 * Resources:: Getting resource values from the server. |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
70 * Display Feature Testing:: Determining the features of a terminal. |
6547 | 71 @end menu |
72 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
73 @xref{Display}, for information about the related topic of |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
74 controlling Emacs redisplay. |
6547 | 75 |
76 @node Creating Frames | |
77 @section Creating Frames | |
78 | |
79 To create a new frame, call the function @code{make-frame}. | |
80 | |
13155
0b8e0559dcee
Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents:
12676
diff
changeset
|
81 @defun make-frame &optional alist |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
82 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
|
83 system, it makes a window frame; otherwise, it makes a terminal frame. |
6547 | 84 |
85 The argument is an alist specifying frame parameters. Any parameters | |
86 not mentioned in @var{alist} default according to the value of the | |
12098 | 87 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
|
88 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
|
89 your system. |
6547 | 90 |
91 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
|
92 window system Emacs uses to display its frames. @xref{Window Frame |
12067 | 93 Parameters}, for documentation of individual parameters you can specify. |
6547 | 94 @end defun |
95 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
96 @defvar before-make-frame-hook |
6547 | 97 A normal hook run by @code{make-frame} before it actually creates the |
98 frame. | |
99 @end defvar | |
100 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
101 @defvar after-make-frame-functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
102 @tindex after-make-frame-functions |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
103 An abnormal hook run by @code{make-frame} after it creates the frame. |
32596
1cb37313bcac
Obsolete variable `after-make-frame-hook'.
Kai Großjohann <kgrossjo@eu.uu.net>
parents:
31375
diff
changeset
|
104 Each function in @code{after-make-frame-functions} receives one argument, the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
105 frame just created. |
6547 | 106 @end defvar |
107 | |
12067 | 108 @node Multiple Displays |
109 @section Multiple Displays | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
110 @cindex multiple X displays |
12067 | 111 @cindex displays, multiple |
112 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
113 A single Emacs can talk to more than one X display. |
12067 | 114 Initially, Emacs uses just one display---the one chosen with the |
115 @code{DISPLAY} environment variable or with the @samp{--display} option | |
116 (@pxref{Initial Options,,, emacs, The GNU Emacs Manual}). To connect to | |
117 another display, use the command @code{make-frame-on-display} or specify | |
118 the @code{display} frame parameter when you create the frame. | |
119 | |
120 Emacs treats each X server as a separate terminal, giving each one its | |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
121 own selected frame and its own minibuffer windows. However, only one of |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
122 those frames is ``@emph{the} selected frame'' at any given moment, see |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
123 @ref{Input Focus}. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
124 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
125 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
|
126 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
|
127 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
|
128 to. These variables include @code{default-minibuffer-frame}, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
129 @code{defining-kbd-macro}, @code{last-kbd-macro}, and |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
130 @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
|
131 be buffer-local (@pxref{Buffer-Local Variables}) or frame-local. |
12067 | 132 |
133 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
|
134 @samp{@var{host}:@var{server}.@var{screen}} has three parts; the last |
12067 | 135 part specifies the screen number for a given server. When you use two |
136 screens belonging to one server, Emacs knows by the similarity in their | |
137 names that they share a single keyboard, and it treats them as a single | |
138 terminal. | |
139 | |
140 @deffn Command make-frame-on-display display &optional parameters | |
141 This creates a new frame on display @var{display}, taking the other | |
142 frame parameters from @var{parameters}. Aside from the @var{display} | |
143 argument, it is like @code{make-frame} (@pxref{Creating Frames}). | |
144 @end deffn | |
145 | |
146 @defun x-display-list | |
147 This returns a list that indicates which X displays Emacs has a | |
12098 | 148 connection to. The elements of the list are strings, and each one is |
149 a display name. | |
12067 | 150 @end defun |
151 | |
26388 | 152 @defun x-open-connection display &optional xrm-string must-succeed |
12067 | 153 This function opens a connection to the X display @var{display}. It |
154 does not create a frame on that display, but it permits you to check | |
155 that communication can be established with that display. | |
156 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
157 The optional argument @var{xrm-string}, if not @code{nil}, is a |
12098 | 158 string of resource names and values, in the same format used in the |
159 @file{.Xresources} file. The values you specify override the resource | |
160 values recorded in the X server itself; they apply to all Emacs frames | |
161 created on this display. Here's an example of what this string might | |
162 look like: | |
163 | |
164 @example | |
165 "*BorderWidth: 3\n*InternalBorder: 2\n" | |
166 @end example | |
167 | |
168 @xref{Resources}. | |
26388 | 169 |
170 If @var{must-succeed} is non-@code{nil}, failure to open the connection | |
171 terminates Emacs. Otherwise, it is an ordinary Lisp error. | |
12067 | 172 @end defun |
173 | |
174 @defun x-close-connection display | |
175 This function closes the connection to display @var{display}. Before | |
176 you can do this, you must first delete all the frames that were open on | |
177 that display (@pxref{Deleting Frames}). | |
178 @end defun | |
179 | |
6547 | 180 @node Frame Parameters |
181 @section Frame Parameters | |
182 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
183 A frame has many parameters that control its appearance and behavior. |
6547 | 184 Just what parameters a frame has depends on what display mechanism it |
185 uses. | |
186 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
187 Frame parameters exist mostly for the sake of window systems. A |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
188 terminal frame has a few parameters, mostly for compatibility's sake; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
189 only the @code{height}, @code{width}, @code{name}, @code{title}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
190 @code{menu-bar-lines}, @code{buffer-list} and @code{buffer-predicate} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
191 parameters do something special. If the terminal supports colors, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
192 parameters @code{foreground-color}, @code{background-color}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
193 @code{background-mode} and @code{display-type} are also meaningful. |
6547 | 194 |
195 @menu | |
196 * Parameter Access:: How to change a frame's parameters. | |
197 * 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
|
198 * 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
|
199 * Size and Position:: Changing the size and position of a frame. |
6547 | 200 @end menu |
201 | |
202 @node Parameter Access | |
203 @subsection Access to Frame Parameters | |
204 | |
205 These functions let you read and change the parameter values of a | |
206 frame. | |
207 | |
26388 | 208 @defun frame-parameter frame parameter |
209 @tindex frame-parameter | |
210 This function returns the value of the parameter named @var{parameter} | |
211 of @var{frame}. If @var{frame} is @code{nil}, it returns the | |
212 selected frame's parameter. | |
213 @end defun | |
214 | |
6547 | 215 @defun frame-parameters frame |
216 The function @code{frame-parameters} returns an alist listing all the | |
217 parameters of @var{frame} and their values. | |
218 @end defun | |
219 | |
220 @defun modify-frame-parameters frame alist | |
221 This function alters the parameters of frame @var{frame} based on the | |
222 elements of @var{alist}. Each element of @var{alist} has the form | |
223 @code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a | |
224 parameter. If you don't mention a parameter in @var{alist}, its value | |
225 doesn't change. | |
226 @end defun | |
227 | |
228 @node Initial Parameters | |
229 @subsection Initial Frame Parameters | |
230 | |
231 You can specify the parameters for the initial startup frame | |
25875 | 232 by setting @code{initial-frame-alist} in your init file (@pxref{Init File}). |
6547 | 233 |
234 @defvar initial-frame-alist | |
235 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
|
236 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
|
237 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
|
238 Each element has the form: |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
239 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
240 @example |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
241 (@var{parameter} . @var{value}) |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
242 @end example |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
243 |
25875 | 244 Emacs creates the initial frame before it reads your init |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
245 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
|
246 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
|
247 created initial frame. |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
248 |
12098 | 249 If these settings affect the frame geometry and appearance, you'll see |
250 the frame appear with the wrong ones and then change to the specified | |
251 ones. If that bothers you, you can specify the same geometry and | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
252 appearance with X resources; those do take effect before the frame is |
45779
4964699e51b4
(Initial Parameters, Resources): Fix references to the Emacs manual.
Andreas Schwab <schwab@suse.de>
parents:
45744
diff
changeset
|
253 created. @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}. |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
254 |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
255 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
|
256 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
|
257 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
|
258 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
|
259 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
|
260 the initial frame, specify the same parameters in |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
261 @code{initial-frame-alist} with values that match the X resources. |
6547 | 262 @end defvar |
263 | |
12098 | 264 If these parameters specify a separate minibuffer-only frame with |
265 @code{(minibuffer . nil)}, and you have not created one, Emacs creates | |
266 one for you. | |
6547 | 267 |
268 @defvar minibuffer-frame-alist | |
269 This variable's value is an alist of parameter values used when creating | |
270 an initial minibuffer-only frame---if such a frame is needed, according | |
271 to the parameters for the main initial frame. | |
272 @end defvar | |
273 | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
274 @defvar default-frame-alist |
16528
62be63ee468d
Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents:
15061
diff
changeset
|
275 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
|
276 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
|
277 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
|
278 in many cases. |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
279 @end defvar |
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
280 |
12098 | 281 See also @code{special-display-frame-alist}, in @ref{Choosing Window}. |
282 | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
283 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
|
284 they take effect by adding elements to @code{default-frame-alist}. One |
12098 | 285 exception is @samp{-geometry}, which adds the specified position to |
286 @code{initial-frame-alist} instead. @xref{Command Arguments,,, emacs, | |
287 The GNU Emacs Manual}. | |
8110
bf6ecdddf78b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7684
diff
changeset
|
288 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
289 @node Window Frame Parameters |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
290 @subsection Window Frame Parameters |
6547 | 291 |
292 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
|
293 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
|
294 window frame; of these, @code{name}, @code{title}, @code{height}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
295 @code{width}, @code{buffer-list} and @code{buffer-predicate} provide |
42752
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
296 meaningful information in terminal frames, and @code{tty-color-mode} |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
297 is meaningful @emph{only} in terminal frames. |
6547 | 298 |
299 @table @code | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
300 @item display |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
301 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
|
302 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
|
303 @code{DISPLAY} environment variable. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
304 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
305 @item title |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
306 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
|
307 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
|
308 if @code{mode-line-frame-identification} uses @samp{%F} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
309 (@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
|
310 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
|
311 @xref{Frame Titles}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
312 |
6547 | 313 @item name |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
314 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
|
315 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
|
316 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
|
317 (@pxref{Frame Titles}). |
6547 | 318 |
319 If you specify the frame name explicitly when you create the frame, the | |
320 name is also used (instead of the name of the Emacs executable) when | |
321 looking up X resources for the frame. | |
322 | |
323 @item left | |
12067 | 324 The screen position of the left edge, in pixels, with respect to the |
325 left edge of the screen. The value may be a positive number @var{pos}, | |
326 or a list of the form @code{(+ @var{pos})} which permits specifying a | |
327 negative @var{pos} value. | |
328 | |
329 A negative number @minus{}@var{pos}, or a list of the form @code{(- | |
330 @var{pos})}, actually specifies the position of the right edge of the | |
12098 | 331 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
|
332 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
|
333 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
|
334 positive. |
6547 | 335 |
12388
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
336 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
|
337 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
|
338 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
|
339 |
6547 | 340 @item top |
12067 | 341 The screen position of the top edge, in pixels, with respect to the |
342 top edge of the screen. The value may be a positive number @var{pos}, | |
343 or a list of the form @code{(+ @var{pos})} which permits specifying a | |
344 negative @var{pos} value. | |
345 | |
346 A negative number @minus{}@var{pos}, or a list of the form @code{(- | |
347 @var{pos})}, actually specifies the position of the bottom edge of the | |
12098 | 348 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
|
349 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
|
350 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
|
351 positive. |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
352 |
12388
35668330115e
Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
353 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
|
354 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
|
355 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
|
356 |
10220
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
357 @item icon-left |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
358 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
|
359 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
|
360 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
|
361 |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
362 @item icon-top |
126f7560fd28
Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents:
9453
diff
changeset
|
363 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
|
364 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
|
365 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
|
366 |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
367 @item user-position |
14658
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
368 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
|
369 @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
|
370 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
|
371 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
|
372 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
|
373 |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
374 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
|
375 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
|
376 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
|
377 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
|
378 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
|
379 ignore them. |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
380 |
c2ed969842dc
Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents:
14200
diff
changeset
|
381 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
|
382 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
|
383 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
|
384 @code{nil}. |
6547 | 385 |
386 @item height | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
387 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
|
388 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) |
6547 | 389 |
390 @item width | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
391 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
|
392 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) |
6547 | 393 |
42713
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
394 @item fullscreen |
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
395 Specify that width, height or both shall be set to the size of the screen. |
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
396 The value @code{fullwidth} specifies that width shall be the size of the |
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
397 screen. The value @code{fullheight} specifies that height shall be the |
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
398 size of the screen. The value @code{fullboth} specifies that both the |
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
399 width and the height shall be set to the size of the screen. |
d977aa26f8f8
(Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
40310
diff
changeset
|
400 |
6547 | 401 @item window-id |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
402 The number of the window-system window used by the frame |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
403 to contain the actual Emacs windows. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
404 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
405 @item outer-window-id |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
406 The number of the outermost window-system window used for the whole frame. |
6547 | 407 |
408 @item minibuffer | |
409 Whether this frame has its own minibuffer. The value @code{t} means | |
410 yes, @code{nil} means no, @code{only} means this frame is just a | |
12098 | 411 minibuffer. If the value is a minibuffer window (in some other frame), |
412 the new frame uses that minibuffer. | |
6547 | 413 |
12067 | 414 @item buffer-predicate |
415 The buffer-predicate function for this frame. The function | |
416 @code{other-buffer} uses this predicate (from the selected frame) to | |
417 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
|
418 @code{nil}. It calls the predicate with one argument, a buffer, once for |
12067 | 419 each buffer; if the predicate returns a non-@code{nil} value, it |
420 considers that buffer. | |
421 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
422 @item buffer-list |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
423 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
|
424 ordered most-recently-selected first. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
425 |
6547 | 426 @item font |
427 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
|
428 string, either a valid font name for your system or the name of an Emacs |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
429 fontset (@pxref{Fontsets}). Changing this frame parameter on a frame |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
430 also changes the font-related attributes of the default face on that |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
431 frame. |
6547 | 432 |
433 @item auto-raise | |
434 Whether selecting the frame raises it (non-@code{nil} means yes). | |
435 | |
436 @item auto-lower | |
437 Whether deselecting the frame lowers it (non-@code{nil} means yes). | |
438 | |
439 @item vertical-scroll-bars | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
440 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
|
441 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
|
442 @code{right}, and @code{nil} for no scroll bars. |
6547 | 443 |
444 @item horizontal-scroll-bars | |
445 Whether the frame has scroll bars for horizontal scrolling | |
446 (non-@code{nil} means yes). (Horizontal scroll bars are not currently | |
447 implemented.) | |
448 | |
12067 | 449 @item scroll-bar-width |
450 The width of the vertical scroll bar, in pixels. | |
451 | |
6547 | 452 @item icon-type |
10759
fe6bdcb0d99f
Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents:
10220
diff
changeset
|
453 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
|
454 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
|
455 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
|
456 picture of a gnu); @code{nil} specifies a text icon. |
6547 | 457 |
12098 | 458 @item icon-name |
459 The name to use in the icon for this frame, when and if the icon | |
460 appears. If this is @code{nil}, the frame's title is used. | |
461 | |
6547 | 462 @item foreground-color |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
463 The color to use for the image of a character. This is a string; the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
464 window system defines the meaningful color names. Changing this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
465 parameter is equivalent to changing the foreground color of the face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
466 @code{default} on the frame in question. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
467 |
6547 | 468 @item background-color |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
469 The color to use for the background of characters. Changing this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
470 parameter is equivalent to changing the foreground color of the face |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
471 @code{default} on the frame in question. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
472 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
473 @item background-mode |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
474 This parameter is either @code{dark} or @code{light}, according |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
475 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
|
476 |
6547 | 477 @item mouse-color |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
478 The color for the mouse pointer. Changing this parameter is equivalent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
479 to changing the background color of face @code{mouse}. |
6547 | 480 |
481 @item cursor-color | |
42752
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
482 The color for the cursor that shows point. Changing this parameter is |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
483 equivalent to changing the background color of face @code{cursor}. |
6547 | 484 |
485 @item border-color | |
42752
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
486 The color for the border of the frame. Changing this parameter is |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
487 equivalent to changing the background color of face @code{border}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
488 |
42752
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
489 @item tty-color-mode |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
490 @cindex standard colors for character terminals |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
491 This parameter overrides the terminal's color support as given by the |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
492 system's terminal capabilities database in that this parameter's value |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
493 specifies the color mode to use in terminal frames. The value can be |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
494 either a symbol or a number. A number specifies the number of colors |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
495 to use (and, indirectly, what commands to issue to produce each |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
496 color). For example, @code{(tty-color-mode . 8)} forces Emacs to use |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
497 the ANSI escape sequences for 8 standard text colors; and a value of |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
498 -1 means Emacs should turn off color support. If the parameter's |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
499 value is a symbol, that symbol is looked up in the alist |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
500 @code{tty-color-mode-alist}, and if found, the associated number is |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
501 used as the color support mode. |
6fce183f6920
(Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents:
42713
diff
changeset
|
502 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
503 @item scroll-bar-foreground |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
504 If non-@code{nil}, the color for the foreground of scroll bars. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
505 Changing this parameter is equivalent to setting the foreground color of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
506 face @code{scroll-bar}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
507 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
508 @item scroll-bar-background |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
509 If non-@code{nil}, the color for the background of scroll bars. |
40310
34f1a01f25fa
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
39504
diff
changeset
|
510 Changing this parameter is equivalent to setting the background color of |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
511 face @code{scroll-bar}. |
6547 | 512 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
513 @item display-type |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
514 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
|
515 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
|
516 @code{mono}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
517 |
6547 | 518 @item cursor-type |
12067 | 519 The way to display the cursor. The legitimate values are @code{bar}, |
520 @code{box}, and @code{(bar . @var{width})}. The symbol @code{box} | |
521 specifies an ordinary black box overlaying the character after point; | |
522 that is the default. The symbol @code{bar} specifies a vertical bar | |
44693
5341e03c6370
(Window Frame Parameters): Document the hbar cursor type.
Eli Zaretskii <eliz@gnu.org>
parents:
43578
diff
changeset
|
523 between characters as the cursor. @code{(bar . @var{width})} |
5341e03c6370
(Window Frame Parameters): Document the hbar cursor type.
Eli Zaretskii <eliz@gnu.org>
parents:
43578
diff
changeset
|
524 specifies a bar @var{width} pixels wide. The symbol @code{hbar} |
5341e03c6370
(Window Frame Parameters): Document the hbar cursor type.
Eli Zaretskii <eliz@gnu.org>
parents:
43578
diff
changeset
|
525 specifies a horizontal bar, an underscore-like cursor. @code{(hbar . |
5341e03c6370
(Window Frame Parameters): Document the hbar cursor type.
Eli Zaretskii <eliz@gnu.org>
parents:
43578
diff
changeset
|
526 @var{width})} specifiles a horizontal bar @var{width} pixels high. |
6547 | 527 |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
528 @vindex cursor-type |
39197
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
529 The buffer-local variable @code{cursor-type} overrides the value of |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
530 the @code{cursor-type} frame parameter, and can in addition have |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
531 values @code{t} (use the cursor specified for the frame) and |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
532 @code{nil} (don't display a cursor). |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
533 |
6547 | 534 @item border-width |
535 The width in pixels of the window border. | |
536 | |
537 @item internal-border-width | |
538 The distance in pixels between text and border. | |
539 | |
540 @item unsplittable | |
541 If non-@code{nil}, this frame's window is never split automatically. | |
542 | |
543 @item visibility | |
544 The state of visibility of the frame. There are three possibilities: | |
545 @code{nil} for invisible, @code{t} for visible, and @code{icon} for | |
546 iconified. @xref{Visibility of Frames}. | |
547 | |
548 @item menu-bar-lines | |
549 The number of lines to allocate at the top of the frame for a menu bar. | |
9453 | 550 The default is 1. @xref{Menu Bar}. (In Emacs versions that use the X |
551 toolkit, there is only one menu bar line; all that matters about the | |
552 number you specify is whether it is greater than zero.) | |
6547 | 553 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
554 @item screen-gamma |
31375 | 555 @cindex gamma correction |
43578
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
556 If this is a number, Emacs performs ``gamma correction'' which adjusts |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
557 the brightness of all colors. The value should be the screen gamma of |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
558 your display, a floating point number. |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
559 |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
560 Usual PC monitors have a screen gamma of 2.2, so color values in |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
561 Emacs, and in X windows generally, are calibrated to display properly |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
562 on a monitor with that gamma value. If you specify 2.2 for |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
563 @code{screen-gamma}, that means no correction is needed. Other values |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
564 request correction, designed to make the corrected colors appear on |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
565 your screen they way they would have appeared without correction on an |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
566 ordinary monitor with a gamma value of 2.2. |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
567 |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
568 If your monitor displays colors too light, you should specify a |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
569 @code{screen-gamma} value smaller than 2.2. This requests correction |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
570 that makes colors darker. A screen gamma value of 1.5 may give good |
fa66c2edee4d
Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents:
43562
diff
changeset
|
571 results for LCD color displays. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
572 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
573 @item tool-bar-lines |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
574 The number of lines to use for the toolbar. A value of @code{nil} means |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
575 don't display a tool bar. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
576 |
31375 | 577 @item line-spacing |
578 Additional space put below text lines in pixels (a positive integer). | |
579 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
580 @ignore |
6547 | 581 @item parent-id |
582 @c ??? Not yet working. | |
583 The X window number of the window that should be the parent of this one. | |
584 Specifying this lets you create an Emacs window inside some other | |
585 application's window. (It is not certain this will be implemented; try | |
586 it and see if it works.) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
587 @end ignore |
6547 | 588 @end table |
589 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
590 @node Size and Position |
6547 | 591 @subsection Frame Size And Position |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
592 @cindex size of frame |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
593 @cindex screen size |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
594 @cindex frame size |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
595 @cindex resize frame |
6547 | 596 |
597 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
|
598 frame parameters @code{left}, @code{top}, @code{height}, and |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
599 @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
|
600 by the window manager in its usual fashion. |
6547 | 601 |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
602 Here are some special features for working with sizes and positions. |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
603 (For the precise meaning of ``selected frame'' used by these functions, |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
604 see @ref{Input Focus}.) |
6547 | 605 |
606 @defun set-frame-position frame left top | |
12098 | 607 This function sets the position of the top left corner of @var{frame} to |
608 @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
|
609 normally count from the top left corner of the screen. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
610 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
611 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
|
612 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
|
613 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
|
614 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
|
615 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
|
616 but it seems inadvisable to change that now. |
6547 | 617 @end defun |
618 | |
619 @defun frame-height &optional frame | |
620 @defunx frame-width &optional frame | |
621 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
|
622 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
|
623 selected frame. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
624 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
625 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
626 @defun screen-height |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
627 @defunx screen-width |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
628 These functions are old aliases for @code{frame-height} and |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
629 @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
|
630 of the frame is normally the same as the size of the terminal screen. |
6547 | 631 @end defun |
632 | |
633 @defun frame-pixel-height &optional frame | |
634 @defunx frame-pixel-width &optional frame | |
635 These functions return the height and width of @var{frame}, measured in | |
636 pixels. If you don't supply @var{frame}, they use the selected frame. | |
637 @end defun | |
638 | |
639 @defun frame-char-height &optional frame | |
640 @defunx frame-char-width &optional frame | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
641 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
|
642 @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
|
643 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
|
644 frame. |
6547 | 645 @end defun |
646 | |
647 @defun set-frame-size frame cols rows | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
648 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
|
649 @var{cols} and @var{rows} specify the new width and height. |
6547 | 650 |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
651 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
|
652 @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
|
653 them to units of characters. |
6547 | 654 @end defun |
655 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
656 @defun set-frame-height frame lines &optional pretend |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
657 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
|
658 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
|
659 fit. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
660 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
661 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
|
662 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
|
663 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
|
664 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
|
665 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
|
666 terminal malfunctions when using its whole screen. Setting the frame |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
667 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
|
668 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
|
669 terminal frame. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
670 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
671 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
672 @defun set-frame-width frame width &optional pretend |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
673 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
|
674 The argument @var{pretend} has the same meaning as in |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
675 @code{set-frame-height}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
676 @end defun |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
677 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
678 @findex set-screen-height |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
679 @findex set-screen-width |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
680 The older functions @code{set-screen-height} and |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
681 @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
|
682 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
|
683 are semi-obsolete, but still work; they apply to the selected frame. |
6547 | 684 |
685 @defun x-parse-geometry geom | |
686 @cindex geometry specification | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
687 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
|
688 geometry string to an alist that you can use as part of the argument to |
6547 | 689 @code{make-frame}. |
690 | |
691 The alist describes which parameters were specified in @var{geom}, and | |
692 gives the values specified for them. Each element looks like | |
693 @code{(@var{parameter} . @var{value})}. The possible @var{parameter} | |
694 values are @code{left}, @code{top}, @code{width}, and @code{height}. | |
695 | |
12067 | 696 For the size parameters, the value must be an integer. The position |
697 parameter names @code{left} and @code{top} are not totally accurate, | |
698 because some values indicate the position of the right or bottom edges | |
699 instead. These are the @var{value} possibilities for the position | |
700 parameters: | |
701 | |
702 @table @asis | |
703 @item an integer | |
704 A positive integer relates the left edge or top edge of the window to | |
705 the left or top edge of the screen. A negative integer relates the | |
706 right or bottom edge of the window to the right or bottom edge of the | |
707 screen. | |
708 | |
12098 | 709 @item @code{(+ @var{position})} |
12067 | 710 This specifies the position of the left or top edge of the window |
711 relative to the left or top edge of the screen. The integer | |
712 @var{position} may be positive or negative; a negative value specifies a | |
713 position outside the screen. | |
714 | |
12098 | 715 @item @code{(- @var{position})} |
12067 | 716 This specifies the position of the right or bottom edge of the window |
717 relative to the right or bottom edge of the screen. The integer | |
718 @var{position} may be positive or negative; a negative value specifies a | |
719 position outside the screen. | |
720 @end table | |
721 | |
722 Here is an example: | |
723 | |
12098 | 724 @example |
6547 | 725 (x-parse-geometry "35x70+0-0") |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
726 @result{} ((height . 70) (width . 35) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
727 (top - 0) (left . 0)) |
12098 | 728 @end example |
6547 | 729 @end defun |
730 | |
12067 | 731 @node Frame Titles |
732 @section Frame Titles | |
733 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
734 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
|
735 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
|
736 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
|
737 frame property. |
12067 | 738 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
739 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
|
740 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
|
741 @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
|
742 frame is redisplayed. |
12067 | 743 |
744 @defvar frame-title-format | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
745 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
|
746 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
|
747 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
|
748 Data}. |
12067 | 749 @end defvar |
750 | |
751 @defvar icon-title-format | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
752 This variable specifies how to compute the name for an iconified frame, |
12067 | 753 when you have not explicitly specified the frame title. This title |
754 appears in the icon itself. | |
755 @end defvar | |
756 | |
757 @defvar multiple-frames | |
758 This variable is set automatically by Emacs. Its value is @code{t} when | |
759 there are two or more frames (not counting minibuffer-only frames or | |
760 invisible frames). The default value of @code{frame-title-format} uses | |
761 @code{multiple-frames} so as to put the buffer name in the frame title | |
762 only when there is more than one frame. | |
763 @end defvar | |
764 | |
6547 | 765 @node Deleting Frames |
766 @section Deleting Frames | |
767 @cindex deletion of frames | |
768 | |
769 Frames remain potentially visible until you explicitly @dfn{delete} | |
770 them. A deleted frame cannot appear on the screen, but continues to | |
771 exist as a Lisp object until there are no references to it. There is no | |
772 way to cancel the deletion of a frame aside from restoring a saved frame | |
773 configuration (@pxref{Frame Configurations}); this is similar to the | |
774 way windows behave. | |
775 | |
26388 | 776 @deffn Command delete-frame &optional frame force |
34015 | 777 @vindex delete-frame-hook |
778 This function deletes the frame @var{frame} after running the hook | |
779 @code{delete-frame-hook}. By default, @var{frame} is the selected | |
780 frame. | |
26388 | 781 |
782 A frame cannot be deleted if its minibuffer is used by other frames. | |
783 Normally, you cannot delete a frame if all other frames are invisible, | |
784 but if the @var{force} is non-@code{nil}, then you are allowed to do so. | |
6547 | 785 @end deffn |
786 | |
787 @defun frame-live-p frame | |
788 The function @code{frame-live-p} returns non-@code{nil} if the frame | |
789 @var{frame} has not been deleted. | |
790 @end defun | |
791 | |
12067 | 792 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
|
793 by sending a special message to the program that operates the window. |
12067 | 794 When Emacs gets one of these commands, it generates a |
795 @code{delete-frame} event, whose normal definition is a command that | |
796 calls the function @code{delete-frame}. @xref{Misc Events}. | |
797 | |
6547 | 798 @node Finding All Frames |
799 @section Finding All Frames | |
800 | |
801 @defun frame-list | |
802 The function @code{frame-list} returns a list of all the frames that | |
803 have not been deleted. It is analogous to @code{buffer-list} for | |
39504
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
804 buffers, and includes frames on all terminals. The list that you get is |
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
805 newly created, so modifying the list doesn't have any effect on the |
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
806 internals of Emacs. |
6547 | 807 @end defun |
808 | |
809 @defun visible-frame-list | |
810 This function returns a list of just the currently visible frames. | |
12067 | 811 @xref{Visibility of Frames}. (Terminal frames always count as |
812 ``visible'', even though only the selected one is actually displayed.) | |
6547 | 813 @end defun |
814 | |
815 @defun next-frame &optional frame minibuf | |
816 The function @code{next-frame} lets you cycle conveniently through all | |
39504
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
817 the frames on the current display from an arbitrary starting point. It |
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
818 returns the ``next'' frame after @var{frame} in the cycle. If |
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
819 @var{frame} is omitted or @code{nil}, it defaults to the selected frame |
af867d560348
(Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents:
39402
diff
changeset
|
820 (@pxref{Input Focus}). |
6547 | 821 |
822 The second argument, @var{minibuf}, says which frames to consider: | |
823 | |
824 @table @asis | |
825 @item @code{nil} | |
826 Exclude minibuffer-only frames. | |
827 @item @code{visible} | |
828 Consider all visible frames. | |
12098 | 829 @item 0 |
830 Consider all visible or iconified frames. | |
6547 | 831 @item a window |
832 Consider only the frames using that particular window as their | |
833 minibuffer. | |
834 @item anything else | |
835 Consider all frames. | |
836 @end table | |
837 @end defun | |
838 | |
839 @defun previous-frame &optional frame minibuf | |
840 Like @code{next-frame}, but cycles through all frames in the opposite | |
841 direction. | |
842 @end defun | |
843 | |
12098 | 844 See also @code{next-window} and @code{previous-window}, in @ref{Cyclic |
845 Window Ordering}. | |
846 | |
6547 | 847 @node Frames and Windows |
848 @section Frames and Windows | |
849 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
850 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
|
851 with @code{window-frame}. |
6547 | 852 |
853 @defun window-frame window | |
854 This function returns the frame that @var{window} is on. | |
855 @end defun | |
856 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
857 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
|
858 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
|
859 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
|
860 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
|
861 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
|
862 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
863 @defun frame-first-window frame |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
864 This returns the topmost, leftmost window of frame @var{frame}. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
865 @end defun |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
866 |
6547 | 867 At any time, exactly one window on any frame is @dfn{selected within the |
868 frame}. The significance of this designation is that selecting the | |
869 frame also selects this window. You can get the frame's current | |
870 selected window with @code{frame-selected-window}. | |
871 | |
872 @defun frame-selected-window frame | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
873 This function returns the window on @var{frame} that is selected within |
6547 | 874 @var{frame}. |
875 @end defun | |
876 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
877 Conversely, selecting a window for Emacs with @code{select-window} also |
6547 | 878 makes that window selected within its frame. @xref{Selecting Windows}. |
879 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
880 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
|
881 frame is @code{minibuffer-window}. @xref{Minibuffer Misc}. |
12098 | 882 |
6547 | 883 @node Minibuffers and Frames |
884 @section Minibuffers and Frames | |
885 | |
886 Normally, each frame has its own minibuffer window at the bottom, which | |
887 is used whenever that frame is selected. If the frame has a minibuffer, | |
888 you can get it with @code{minibuffer-window} (@pxref{Minibuffer Misc}). | |
889 | |
890 However, you can also create a frame with no minibuffer. Such a frame | |
891 must use the minibuffer window of some other frame. When you create the | |
12098 | 892 frame, you can specify explicitly the minibuffer window to use (in some |
893 other frame). If you don't, then the minibuffer is found in the frame | |
894 which is the value of the variable @code{default-minibuffer-frame}. Its | |
895 value should be a frame that does have a minibuffer. | |
6547 | 896 |
897 If you use a minibuffer-only frame, you might want that frame to raise | |
898 when you enter the minibuffer. If so, set the variable | |
899 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}. | |
900 | |
12067 | 901 @defvar default-minibuffer-frame |
902 This variable specifies the frame to use for the minibuffer window, by | |
12098 | 903 default. It is always local to the current terminal and cannot be |
12067 | 904 buffer-local. @xref{Multiple Displays}. |
905 @end defvar | |
906 | |
6547 | 907 @node Input Focus |
908 @section Input Focus | |
909 @cindex input focus | |
910 @cindex selected frame | |
911 | |
912 At any time, one frame in Emacs is the @dfn{selected frame}. The selected | |
913 window always resides on the selected frame. | |
914 | |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
915 When Emacs displays its frames on several terminals (@pxref{Multiple |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
916 Displays}), each terminal has its own selected frame. But only one of |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
917 these is ``@emph{the} selected frame'': it's the frame that belongs to |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
918 the terminal from which the most recent input came. That is, when Emacs |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
919 runs a command that came from a certain terminal, the selected frame is |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
920 the one of that terminal. Since Emacs runs only a single command at any |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
921 given time, it needs to consider only one selected frame at a time; this |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
922 frame is what we call @dfn{the selected frame} in this manual. The |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
923 display on which the selected frame is displayed is the @dfn{selected |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
924 frame's display}. |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
925 |
6547 | 926 @defun selected-frame |
927 This function returns the selected frame. | |
928 @end defun | |
929 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
930 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
|
931 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
|
932 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
|
933 way, Emacs automatically keeps track of which frame has the focus. |
6547 | 934 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
935 Lisp programs can also switch frames ``temporarily'' by calling the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
936 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
|
937 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
|
938 until that control is somehow reasserted. |
6547 | 939 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
940 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
|
941 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
|
942 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
|
943 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
|
944 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
|
945 in the mode line before the buffer name (@pxref{Mode Line Variables}). |
12067 | 946 |
6547 | 947 @c ??? This is not yet implemented properly. |
948 @defun select-frame frame | |
949 This function selects frame @var{frame}, temporarily disregarding the | |
12067 | 950 focus of the X server if any. The selection of @var{frame} lasts until |
951 the next time the user does something to select a different frame, or | |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
952 until the next time this function is called. The specified @var{frame} |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
953 becomes the selected frame, as explained above, and the terminal that |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
954 @var{frame} is on becomes the selected terminal. |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
955 |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
956 In general, you should never use @code{select-frame} in a way that could |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
957 switch to a different terminal without switching back when you're done. |
6547 | 958 @end defun |
959 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
960 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
|
961 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
|
962 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
|
963 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
|
964 @code{handle-switch-frame}. @xref{Focus Events}. |
6547 | 965 |
966 @deffn Command handle-switch-frame frame | |
967 This function handles a focus event by selecting frame @var{frame}. | |
968 | |
969 Focus events normally do their job by invoking this command. | |
970 Don't call it for any other reason. | |
971 @end deffn | |
972 | |
973 @defun redirect-frame-focus frame focus-frame | |
974 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
|
975 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
|
976 events intended for @var{frame}. After such an event, the value of |
6547 | 977 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame |
978 events specifying @var{frame} will instead select @var{focus-frame}. | |
979 | |
980 If @var{focus-frame} is @code{nil}, that cancels any existing | |
981 redirection for @var{frame}, which therefore once again receives its own | |
982 events. | |
983 | |
984 One use of focus redirection is for frames that don't have minibuffers. | |
985 These frames use minibuffers on other frames. Activating a minibuffer | |
986 on another frame redirects focus to that frame. This puts the focus on | |
987 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
|
988 in the frame that activated the minibuffer. |
6547 | 989 |
990 Selecting a frame can also change focus redirections. Selecting frame | |
991 @code{bar}, when @code{foo} had been selected, changes any redirections | |
992 pointing to @code{foo} so that they point to @code{bar} instead. This | |
993 allows focus redirection to work properly when the user switches from | |
994 one frame to another using @code{select-window}. | |
995 | |
996 This means that a frame whose focus is redirected to itself is treated | |
997 differently from a frame whose focus is not redirected. | |
998 @code{select-frame} affects the former but not the latter. | |
999 | |
1000 The redirection lasts until @code{redirect-frame-focus} is called to | |
1001 change it. | |
1002 @end defun | |
1003 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1004 @defopt focus-follows-mouse |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1005 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
|
1006 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
|
1007 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
|
1008 position consistent with the new selected frame. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1009 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1010 |
6547 | 1011 @node Visibility of Frames |
1012 @section Visibility of Frames | |
1013 @cindex visible frame | |
1014 @cindex invisible frame | |
1015 @cindex iconified frame | |
1016 @cindex frame visibility | |
1017 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1018 A window frame may be @dfn{visible}, @dfn{invisible}, or |
12067 | 1019 @dfn{iconified}. If it is visible, you can see its contents. If it is |
1020 iconified, the frame's contents do not appear on the screen, but an icon | |
1021 does. If the frame is invisible, it doesn't show on the screen, not | |
1022 even as an icon. | |
1023 | |
1024 Visibility is meaningless for terminal frames, since only the selected | |
1025 one is actually displayed in any case. | |
6547 | 1026 |
1027 @deffn Command make-frame-visible &optional frame | |
1028 This function makes frame @var{frame} visible. If you omit @var{frame}, | |
1029 it makes the selected frame visible. | |
1030 @end deffn | |
1031 | |
1032 @deffn Command make-frame-invisible &optional frame | |
1033 This function makes frame @var{frame} invisible. If you omit | |
1034 @var{frame}, it makes the selected frame invisible. | |
1035 @end deffn | |
1036 | |
1037 @deffn Command iconify-frame &optional frame | |
1038 This function iconifies frame @var{frame}. If you omit @var{frame}, it | |
1039 iconifies the selected frame. | |
1040 @end deffn | |
1041 | |
1042 @defun frame-visible-p frame | |
1043 This returns the visibility status of frame @var{frame}. The value is | |
1044 @code{t} if @var{frame} is visible, @code{nil} if it is invisible, and | |
1045 @code{icon} if it is iconified. | |
1046 @end defun | |
1047 | |
1048 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
|
1049 parameter. You can read or change it as such. @xref{Window Frame |
6547 | 1050 Parameters}. |
1051 | |
12067 | 1052 The user can iconify and deiconify frames with the window manager. |
1053 This happens below the level at which Emacs can exert any control, but | |
1054 Emacs does provide events that you can use to keep track of such | |
1055 changes. @xref{Misc Events}. | |
1056 | |
6547 | 1057 @node Raising and Lowering |
1058 @section Raising and Lowering Frames | |
1059 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1060 Most window systems use a desktop metaphor. Part of this metaphor is |
6547 | 1061 the idea that windows are stacked in a notional third dimension |
1062 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
|
1063 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
|
1064 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
|
1065 seen if no other window overlaps it. |
6547 | 1066 |
1067 @cindex raising a frame | |
1068 @cindex lowering a frame | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1069 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
|
1070 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
|
1071 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
|
1072 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
|
1073 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
|
1074 on the screen. |
6547 | 1075 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1076 You can raise and lower Emacs frame Windows with these functions: |
6547 | 1077 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1078 @deffn Command raise-frame &optional frame |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1079 This function raises frame @var{frame} (default, the selected frame). |
12067 | 1080 @end deffn |
6547 | 1081 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1082 @deffn Command lower-frame &optional frame |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1083 This function lowers frame @var{frame} (default, the selected frame). |
12067 | 1084 @end deffn |
6547 | 1085 |
1086 @defopt minibuffer-auto-raise | |
1087 If this is non-@code{nil}, activation of the minibuffer raises the frame | |
1088 that the minibuffer window is in. | |
1089 @end defopt | |
1090 | |
1091 You can also enable auto-raise (raising automatically when a frame is | |
1092 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
|
1093 for any frame using frame parameters. @xref{Window Frame Parameters}. |
6547 | 1094 |
1095 @node Frame Configurations | |
1096 @section Frame Configurations | |
1097 @cindex frame configuration | |
1098 | |
1099 A @dfn{frame configuration} records the current arrangement of frames, | |
1100 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
|
1101 (@xref{Window Configurations}.) |
6547 | 1102 |
1103 @defun current-frame-configuration | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1104 This function returns a frame configuration list that describes |
6547 | 1105 the current arrangement of frames and their contents. |
1106 @end defun | |
1107 | |
26388 | 1108 @defun set-frame-configuration configuration &optional nodelete |
6547 | 1109 This function restores the state of frames described in |
1110 @var{configuration}. | |
26388 | 1111 |
1112 Ordinarily, this function deletes all existing frames not listed in | |
1113 @var{configuration}. But if @var{nodelete} is non-@code{nil}, the | |
1114 unwanted frames are iconified instead. | |
6547 | 1115 @end defun |
1116 | |
1117 @node Mouse Tracking | |
1118 @section Mouse Tracking | |
1119 @cindex mouse tracking | |
1120 @cindex tracking the mouse | |
1121 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1122 Sometimes it is useful to @dfn{track} the mouse, which means to display |
6547 | 1123 something to indicate where the mouse is and move the indicator as the |
1124 mouse moves. For efficient mouse tracking, you need a way to wait until | |
1125 the mouse actually moves. | |
1126 | |
1127 The convenient way to track the mouse is to ask for events to represent | |
1128 mouse motion. Then you can wait for motion by waiting for an event. In | |
1129 addition, you can easily handle any other sorts of events that may | |
1130 occur. That is useful, because normally you don't want to track the | |
1131 mouse forever---only until some other event, such as the release of a | |
1132 button. | |
1133 | |
1134 @defspec track-mouse body@dots{} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1135 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
|
1136 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
|
1137 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
|
1138 Events}, for the format of mouse motion events. |
6547 | 1139 |
1140 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
|
1141 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
|
1142 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
|
1143 it is time to stop tracking. |
6547 | 1144 @end defspec |
1145 | |
1146 The usual purpose of tracking mouse motion is to indicate on the screen | |
1147 the consequences of pushing or releasing a button at the current | |
1148 position. | |
1149 | |
12098 | 1150 In many cases, you can avoid the need to track the mouse by using |
1151 the @code{mouse-face} text property (@pxref{Special Properties}). | |
1152 That works at a much lower level and runs more smoothly than | |
1153 Lisp-level mouse tracking. | |
1154 | |
6547 | 1155 @ignore |
1156 @c These are not implemented yet. | |
1157 | |
1158 These functions change the screen appearance instantaneously. The | |
1159 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
|
1160 is OK for mouse tracking, since it doesn't make sense for mouse tracking |
6547 | 1161 to change the text, and the body of @code{track-mouse} normally reads |
1162 the events itself and does not do redisplay. | |
1163 | |
1164 @defun x-contour-region window beg end | |
1165 This function draws lines to make a box around the text from @var{beg} | |
1166 to @var{end}, in window @var{window}. | |
1167 @end defun | |
1168 | |
1169 @defun x-uncontour-region window beg end | |
1170 This function erases the lines that would make a box around the text | |
1171 from @var{beg} to @var{end}, in window @var{window}. Use it to remove | |
1172 a contour that you previously made by calling @code{x-contour-region}. | |
1173 @end defun | |
1174 | |
1175 @defun x-draw-rectangle frame left top right bottom | |
1176 This function draws a hollow rectangle on frame @var{frame} with the | |
1177 specified edge coordinates, all measured in pixels from the inside top | |
1178 left corner. It uses the cursor color, the one used for indicating the | |
1179 location of point. | |
1180 @end defun | |
1181 | |
1182 @defun x-erase-rectangle frame left top right bottom | |
1183 This function erases a hollow rectangle on frame @var{frame} with the | |
1184 specified edge coordinates, all measured in pixels from the inside top | |
1185 left corner. Erasure means redrawing the text and background that | |
1186 normally belong in the specified rectangle. | |
1187 @end defun | |
1188 @end ignore | |
1189 | |
1190 @node Mouse Position | |
1191 @section Mouse Position | |
1192 @cindex mouse position | |
1193 @cindex position of mouse | |
1194 | |
1195 The functions @code{mouse-position} and @code{set-mouse-position} | |
1196 give access to the current position of the mouse. | |
1197 | |
1198 @defun mouse-position | |
1199 This function returns a description of the position of the mouse. The | |
1200 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
|
1201 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
|
1202 the top left corner of the inside of @var{frame}. |
6547 | 1203 @end defun |
1204 | |
39197
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1205 @defvar mouse-position-function |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1206 If non-@code{nil}, the value of this variable is a function for |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1207 @code{mouse-position} to call. @code{mouse-position} calls this |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1208 function just before returning, with its normal return value as the |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1209 sole argument, and it returns whatever this function returns to it. |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1210 |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1211 This abnormal hook exists for the benefit of packages like |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1212 @file{xt-mouse.el} that need to do mouse handling at the Lisp level. |
39197
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1213 @end defvar |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1214 |
6547 | 1215 @defun set-mouse-position frame x y |
1216 This function @dfn{warps the mouse} to position @var{x}, @var{y} in | |
1217 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
|
1218 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
|
1219 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
|
1220 does nothing. The return value is not significant. |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1221 @end defun |
6547 | 1222 |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1223 @defun mouse-pixel-position |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1224 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
|
1225 coordinates in units of pixels rather than units of characters. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1226 @end defun |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1227 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1228 @defun set-mouse-pixel-position frame x y |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1229 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
|
1230 @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
|
1231 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
|
1232 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1233 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
|
1234 value is not significant. |
6547 | 1235 @end defun |
1236 | |
1237 @need 3000 | |
1238 | |
1239 @node Pop-Up Menus | |
1240 @section Pop-Up Menus | |
1241 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1242 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
|
1243 the user can choose an alternative with the mouse. |
12067 | 1244 |
6547 | 1245 @defun x-popup-menu position menu |
1246 This function displays a pop-up menu and returns an indication of | |
1247 what selection the user makes. | |
1248 | |
1249 The argument @var{position} specifies where on the screen to put the | |
1250 menu. It can be either a mouse button event (which says to put the menu | |
1251 where the user actuated the button) or a list of this form: | |
1252 | |
1253 @example | |
1254 ((@var{xoffset} @var{yoffset}) @var{window}) | |
1255 @end example | |
1256 | |
1257 @noindent | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1258 where @var{xoffset} and @var{yoffset} are coordinates, measured in |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1259 pixels, counting from the top left corner of @var{window}'s frame. |
6547 | 1260 |
1261 If @var{position} is @code{t}, it means to use the current mouse | |
1262 position. If @var{position} is @code{nil}, it means to precompute the | |
1263 key binding equivalents for the keymaps specified in @var{menu}, | |
1264 without actually displaying or popping up the menu. | |
1265 | |
1266 The argument @var{menu} says what to display in the menu. It can be a | |
1267 keymap or a list of keymaps (@pxref{Menu Keymaps}). Alternatively, it | |
1268 can have the following form: | |
1269 | |
1270 @example | |
1271 (@var{title} @var{pane1} @var{pane2}...) | |
1272 @end example | |
1273 | |
1274 @noindent | |
1275 where each pane is a list of form | |
1276 | |
1277 @example | |
12098 | 1278 (@var{title} (@var{line} . @var{item})...) |
6547 | 1279 @end example |
1280 | |
1281 Each @var{line} should be a string, and each @var{item} should be the | |
1282 value to return if that @var{line} is chosen. | |
1283 @end defun | |
1284 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1285 @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
|
1286 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
|
1287 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
|
1288 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
|
1289 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
|
1290 @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
|
1291 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
|
1292 |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1293 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
|
1294 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
|
1295 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
|
1296 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
|
1297 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
|
1298 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
|
1299 @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
|
1300 |
5a3beebafdcb
Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents:
13155
diff
changeset
|
1301 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
|
1302 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
|
1303 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
|
1304 the menu keymap as necessary. |
6547 | 1305 |
1306 @node Dialog Boxes | |
1307 @section Dialog Boxes | |
1308 @cindex dialog boxes | |
1309 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1310 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
|
1311 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
|
1312 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
|
1313 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
|
1314 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
|
1315 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
|
1316 by mouse clicks. |
6547 | 1317 |
1318 @defun x-popup-dialog position contents | |
1319 This function displays a pop-up dialog box and returns an indication of | |
1320 what selection the user makes. The argument @var{contents} specifies | |
1321 the alternatives to offer; it has this format: | |
1322 | |
1323 @example | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1324 (@var{title} (@var{string} . @var{value})@dots{}) |
6547 | 1325 @end example |
1326 | |
1327 @noindent | |
1328 which looks like the list that specifies a single pane for | |
1329 @code{x-popup-menu}. | |
1330 | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1331 The return value is @var{value} from the chosen alternative. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1332 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1333 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
|
1334 @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
|
1335 be selected. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1336 |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1337 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
|
1338 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
|
1339 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
|
1340 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
|
1341 items appear on each side. |
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1342 |
6547 | 1343 Dialog boxes always appear in the center of a frame; the argument |
1344 @var{position} specifies which frame. The possible values are as in | |
1345 @code{x-popup-menu}, but the precise coordinates don't matter; only the | |
1346 frame matters. | |
7174
0313f520a4d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6547
diff
changeset
|
1347 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1348 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
|
1349 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
|
1350 frame. |
6547 | 1351 @end defun |
1352 | |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1353 @node Pointer Shapes |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1354 @section Pointer Shapes |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1355 @cindex pointer shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1356 @cindex mouse pointer shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1357 |
12067 | 1358 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
|
1359 various situations, when using the X Window System: |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1360 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1361 @table @code |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1362 @item x-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1363 @vindex x-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1364 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
|
1365 frame. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1366 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1367 @item x-sensitive-text-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1368 @vindex x-sensitive-text-pointer-shape |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1369 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
|
1370 is over mouse-sensitive text. |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1371 @end table |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1372 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1373 These variables affect newly created frames. They do not normally |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1374 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
|
1375 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
|
1376 these variables. @xref{Window Frame Parameters}. |
7684
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1377 |
ec7caebc4a1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7174
diff
changeset
|
1378 The values you can use, to specify either of these pointer shapes, are |
15061 | 1379 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
|
1380 @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
|
1381 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1382 @node Window System Selections |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1383 @section Window System Selections |
35476 | 1384 @cindex selection (for window systems) |
6547 | 1385 |
1386 The X server records a set of @dfn{selections} which permit transfer of | |
1387 data between application programs. The various selections are | |
1388 distinguished by @dfn{selection types}, represented in Emacs by | |
1389 symbols. X clients including Emacs can read or set the selection for | |
1390 any given type. | |
1391 | |
1392 @defun x-set-selection type data | |
1393 This function sets a ``selection'' in the X server. It takes two | |
1394 arguments: a selection type @var{type}, and the value to assign to it, | |
1395 @var{data}. If @var{data} is @code{nil}, it means to clear out the | |
1396 selection. Otherwise, @var{data} may be a string, a symbol, an integer | |
1397 (or a cons of two integers or list of two integers), an overlay, or a | |
1398 cons of two markers pointing to the same buffer. An overlay or a pair | |
1399 of markers stands for text in the overlay or between the markers. | |
1400 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1401 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
|
1402 selection values. |
6547 | 1403 |
1404 Each possible @var{type} has its own selection value, which changes | |
1405 independently. The usual values of @var{type} are @code{PRIMARY} and | |
1406 @code{SECONDARY}; these are symbols with upper-case names, in accord | |
1407 with X Window System conventions. The default is @code{PRIMARY}. | |
1408 @end defun | |
1409 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1410 @defun x-get-selection &optional type data-type |
6547 | 1411 This function accesses selections set up by Emacs or by other X |
1412 clients. It takes two optional arguments, @var{type} and | |
1413 @var{data-type}. The default for @var{type}, the selection type, is | |
1414 @code{PRIMARY}. | |
1415 | |
1416 The @var{data-type} argument specifies the form of data conversion to | |
1417 use, to convert the raw data obtained from another X client into Lisp | |
1418 data. Meaningful values include @code{TEXT}, @code{STRING}, | |
1419 @code{TARGETS}, @code{LENGTH}, @code{DELETE}, @code{FILE_NAME}, | |
1420 @code{CHARACTER_POSITION}, @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, | |
1421 @code{OWNER_OS}, @code{HOST_NAME}, @code{USER}, @code{CLASS}, | |
1422 @code{NAME}, @code{ATOM}, and @code{INTEGER}. (These are symbols with | |
1423 upper-case names in accord with X conventions.) The default for | |
1424 @var{data-type} is @code{STRING}. | |
1425 @end defun | |
1426 | |
1427 @cindex cut buffer | |
1428 The X server also has a set of numbered @dfn{cut buffers} which can | |
1429 store text or other data being moved between applications. Cut buffers | |
1430 are considered obsolete, but Emacs supports them for the sake of X | |
1431 clients that still use them. | |
1432 | |
1433 @defun x-get-cut-buffer n | |
1434 This function returns the contents of cut buffer number @var{n}. | |
1435 @end defun | |
1436 | |
26388 | 1437 @defun x-set-cut-buffer string &optional push |
6547 | 1438 This function stores @var{string} into the first cut buffer (cut buffer |
26388 | 1439 0). If @var{push} is @code{nil}, only the first cut buffer is changed. |
1440 If @var{push} is non-@code{nil}, that says to move the values down | |
1441 through the series of cut buffers, much like the way successive kills in | |
1442 Emacs move down the kill ring. In other words, the previous value of | |
1443 the first cut buffer moves into the second cut buffer, and the second to | |
1444 the third, and so on through all eight cut buffers. | |
6547 | 1445 @end defun |
1446 | |
22742
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1447 @defvar selection-coding-system |
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1448 This variable specifies the coding system to use when reading and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1449 writing selections, the clipboard, or a cut buffer. @xref{Coding |
43562
ca00a6c76017
(Window System Selections): The default encoding is now
Eli Zaretskii <eliz@gnu.org>
parents:
43142
diff
changeset
|
1450 Systems}. The default is @code{compound-text-with-extensions}, which |
ca00a6c76017
(Window System Selections): The default encoding is now
Eli Zaretskii <eliz@gnu.org>
parents:
43142
diff
changeset
|
1451 converts to the text representation that X11 normally uses. |
22742
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1452 @end defvar |
39fe58403429
Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents:
22274
diff
changeset
|
1453 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1454 @cindex clipboard support (for MS-Windows) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1455 When Emacs runs on MS-Windows, it does not implement X selections in |
36348
3fd0e91fef4e
(Window System Selections): Remove doubled `it'.
Gerd Moellmann <gerd@gnu.org>
parents:
35476
diff
changeset
|
1456 general, but it does support the clipboard. @code{x-get-selection} |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1457 and @code{x-set-selection} on MS-Windows support the text data type |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1458 only; if the clipboard holds other types of data, Emacs treats the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1459 clipboard as empty. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1460 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1461 @defopt x-select-enable-clipboard |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1462 If this is non-@code{nil}, the Emacs yank functions consult the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1463 clipboard before the primary selection, and the kill functions store in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1464 the clipboard as well as the primary selection. Otherwise they do not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1465 access the clipboard at all. The default is @code{nil} on most systems, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1466 but @code{t} on MS-Windows. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1467 @end defopt |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1468 |
12098 | 1469 @node Color Names |
1470 @section Color Names | |
6547 | 1471 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1472 These functions provide a way to determine which color names are |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1473 valid, and what they look like. In some cases, the value depends on the |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1474 @dfn{selected frame}, as described below; see @ref{Input Focus}, for the |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1475 meaning of the term ``selected frame''. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1476 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1477 @defun color-defined-p color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1478 @tindex color-defined-p |
8712 | 1479 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
|
1480 @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
|
1481 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
|
1482 @code{nil}, the selected frame is used. |
8712 | 1483 |
1484 Note that this does not tell you whether the display you are using | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1485 really supports that color. When using X, you can ask for any defined |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1486 color on any kind of display, and you will get some result---typically, |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1487 the closest it can do. To determine whether a frame can really display |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1488 a certain color, use @code{color-supported-p} (see below). |
8712 | 1489 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1490 @findex x-color-defined-p |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1491 This function used to be called @code{x-color-defined-p}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1492 and that name is still supported as an alias. |
8712 | 1493 @end defun |
6547 | 1494 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1495 @defun defined-colors &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1496 @tindex defined-colors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1497 This function returns a list of the color names that are defined |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1498 and supported on frame @var{frame} (default, the selected frame). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1499 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1500 @findex x-defined-colors |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1501 This function used to be called @code{x-defined-colors}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1502 and that name is still supported as an alias. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1503 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1504 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1505 @defun color-supported-p color &optional frame background-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1506 @tindex color-supported-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1507 This returns @code{t} if @var{frame} can really display the color |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1508 @var{color} (or at least something close to it). If @var{frame} is |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1509 omitted or @code{nil}, the question applies to the selected frame. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1510 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1511 Some terminals support a different set of colors for foreground and |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1512 background. If @var{background-p} is non-@code{nil}, that means you are |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1513 asking whether @var{color} can be used as a background; otherwise you |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1514 are asking whether it can be used as a foreground. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1515 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1516 The argument @var{color} must be a valid color name. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1517 @end defun |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1518 |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1519 @defun color-gray-p color &optional frame |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1520 @tindex color-gray-p |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1521 This returns @code{t} if @var{color} is a shade of gray, as defined on |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1522 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, the |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1523 question applies to the selected frame. The argument @var{color} must |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1524 be a valid color name. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1525 @end defun |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1526 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1527 @defun color-values color &optional frame |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1528 @tindex color-values |
8712 | 1529 This function returns a value that describes what @var{color} should |
1530 ideally look like. If @var{color} is defined, the value is a list of | |
1531 three integers, which give the amount of red, the amount of green, and | |
1532 the amount of blue. Each integer ranges in principle from 0 to 65535, | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1533 but in practice no value seems to be above 65280. This kind |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1534 of three-element list is called an @dfn{rgb value}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1535 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1536 If @var{color} is not defined, the value is @code{nil}. |
8712 | 1537 |
1538 @example | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1539 (color-values "black") |
8712 | 1540 @result{} (0 0 0) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1541 (color-values "white") |
8712 | 1542 @result{} (65280 65280 65280) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1543 (color-values "red") |
8712 | 1544 @result{} (65280 0 0) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1545 (color-values "pink") |
8712 | 1546 @result{} (65280 49152 51968) |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1547 (color-values "hungry") |
8712 | 1548 @result{} nil |
1549 @end example | |
12676
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1550 |
d97688032b10
multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents:
12388
diff
changeset
|
1551 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
|
1552 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
|
1553 frame's display. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1554 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1555 @findex x-color-values |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1556 This function used to be called @code{x-color-values}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1557 and that name is still supported as an alias. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1558 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1559 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1560 @node Text Terminal Colors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1561 @section Text Terminal Colors |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1562 @cindex colors on text-only terminals |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1563 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1564 Emacs can display color on text-only terminals, starting with version |
42957
6a35c3566bfd
(Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents:
42752
diff
changeset
|
1565 21. These terminals usually support only a small number of colors, and |
6a35c3566bfd
(Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents:
42752
diff
changeset
|
1566 the computer uses small integers to select colors on the terminal. This |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1567 means that the computer cannot reliably tell what the selected color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1568 looks like; instead, you have to inform your application which small |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1569 integers correspond to which colors. However, Emacs does know the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1570 standard set of colors and will try to use them automatically. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1571 |
42957
6a35c3566bfd
(Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents:
42752
diff
changeset
|
1572 The functions described in this section control how terminal colors |
6a35c3566bfd
(Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents:
42752
diff
changeset
|
1573 are used by Emacs. |
6a35c3566bfd
(Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents:
42752
diff
changeset
|
1574 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1575 @cindex rgb value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1576 Several of these functions use or return @dfn{rgb values}. An rgb |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1577 value is a list of three integers, which give the amount of red, the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1578 amount of green, and the amount of blue. Each integer ranges in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1579 principle from 0 to 65535, but in practice the largest value used is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1580 65280. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1581 |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1582 These functions accept a display (either a frame or the name of a |
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1583 terminal) as an optional argument. We hope in the future to make Emacs |
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1584 support more than one text-only terminal at one time; then this argument |
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1585 will specify which terminal to operate on (the default being the |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1586 selected frame's terminal; @pxref{Input Focus}). At present, though, |
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1587 the @var{display} argument has no effect. |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1588 |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1589 @defun tty-color-define name number &optional rgb display |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1590 @tindex tty-color-define |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1591 This function associates the color name @var{name} with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1592 color number @var{number} on the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1593 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1594 The optional argument @var{rgb}, if specified, is an rgb value; it says |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1595 what the color actually looks like. If you do not specify @var{rgb}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1596 then this color cannot be used by @code{tty-color-approximate} to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1597 approximate other colors, because Emacs does not know what it looks |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1598 like. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1599 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1600 |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1601 @defun tty-color-clear &optional display |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1602 @tindex tty-color-clear |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1603 This function clears the table of defined colors for a text-only terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1604 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1605 |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1606 @defun tty-color-alist &optional display |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1607 @tindex tty-color-alist |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1608 This function returns an alist recording the known colors supported by a |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1609 text-only terminal. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1610 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1611 Each element has the form @code{(@var{name} @var{number} . @var{rgb})} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1612 or @code{(@var{name} @var{number})}. Here, @var{name} is the color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1613 name, @var{number} is the number used to specify it to the terminal. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1614 If present, @var{rgb} is an rgb value that says what the color |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1615 actually looks like. |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1616 @end defun |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1617 |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1618 @defun tty-color-approximate rgb &optional display |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1619 @tindex tty-color-approximate |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1620 This function finds the closest color, among the known colors supported |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1621 for @var{display}, to that described by the rgb value @var{rgb}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1622 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1623 |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1624 @defun tty-color-translate color &optional display |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1625 @tindex tty-color-translate |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1626 This function finds the closest color to @var{color} among the known |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1627 colors supported for @var{display}. If the name @var{color} is not |
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
1628 defined, the value is @code{nil}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1629 |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1630 @var{color} can be an X-style @code{"#@var{xxxyyyzzz}"} specification |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1631 instead of an actual name. The format |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26388
diff
changeset
|
1632 @code{"RGB:@var{xx}/@var{yy}/@var{zz}"} is also supported. |
6547 | 1633 @end defun |
1634 | |
1635 @node Resources | |
1636 @section X Resources | |
1637 | |
12098 | 1638 @defun x-get-resource attribute class &optional component subclass |
6547 | 1639 The function @code{x-get-resource} retrieves a resource value from the X |
1640 Windows defaults database. | |
1641 | |
1642 Resources are indexed by a combination of a @dfn{key} and a @dfn{class}. | |
1643 This function searches using a key of the form | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8110
diff
changeset
|
1644 @samp{@var{instance}.@var{attribute}} (where @var{instance} is the name |
12098 | 1645 under which Emacs was invoked), and using @samp{Emacs.@var{class}} as |
1646 the class. | |
6547 | 1647 |
1648 The optional arguments @var{component} and @var{subclass} add to the key | |
1649 and the class, respectively. You must specify both of them or neither. | |
1650 If you specify them, the key is | |
1651 @samp{@var{instance}.@var{component}.@var{attribute}}, and the class is | |
12098 | 1652 @samp{Emacs.@var{class}.@var{subclass}}. |
6547 | 1653 @end defun |
1654 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1655 @defvar x-resource-class |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1656 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
|
1657 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
|
1658 resources for application names other than ``Emacs'' by binding this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1659 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
|
1660 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16528
diff
changeset
|
1661 |
45779
4964699e51b4
(Initial Parameters, Resources): Fix references to the Emacs manual.
Andreas Schwab <schwab@suse.de>
parents:
45744
diff
changeset
|
1662 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}. |
6547 | 1663 |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1664 @node Display Feature Testing |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1665 @section Display Feature Testing |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1666 @cindex display feature testing |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1667 |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1668 The functions in this section describe the basic capabilities of a |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1669 particular display. Lisp programs can use them to adapt their behavior |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1670 to what the display can do. For example, a program that ordinarly uses |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1671 a popup menu could use the minibuffer if popup menus are not supported. |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1672 |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1673 The optional argument @var{display} in these functions specifies which |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1674 display to ask the question about. It can be a display name, a frame |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1675 (which designates the display that frame is on), or @code{nil} (which |
39402
3a102bf6010f
(Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents:
39221
diff
changeset
|
1676 refers to the selected frame's display, @pxref{Input Focus}). |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1677 |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1678 @xref{Color Names}, @ref{Text Terminal Colors}, for other functions to |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1679 obtain information about displays. |
6547 | 1680 |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1681 @defun display-popup-menus-p &optional display |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1682 @tindex display-popup-menus-p |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1683 This function returns @code{t} if popup menus are supported on |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1684 @var{display}, @code{nil} if not. Support for popup menus requires that |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1685 the mouse be available, since the user cannot choose menu items without |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1686 a mouse. |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1687 @end defun |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1688 |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1689 @defun display-graphic-p &optional display |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1690 @tindex display-graphic-p |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1691 @cindex frames, more than one on display |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1692 @cindex fonts, more than one on display |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1693 This function returns @code{t} if @var{display} is a graphic display |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1694 capable of displaying several frames and several different fonts at |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1695 once. This is true for displays that use a window system such as X, and |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1696 false for text-only terminals. |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1697 @end defun |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1698 |
27654
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1699 @defun display-mouse-p &optional display |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1700 @tindex display-mouse-p |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1701 @cindex mouse, availability |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1702 This function returns @code{t} if @var{display} has a mouse available, |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1703 @code{nil} if not. |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1704 @end defun |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1705 |
27532
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1706 @defun display-color-p &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1707 @tindex display-color-p |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1708 @findex x-display-color-p |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1709 This function returns @code{t} if the screen is a color screen. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1710 It used to be called @code{x-display-color-p}, and that name |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1711 is still supported as an alias. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1712 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1713 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1714 @defun display-grayscale-p &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1715 @tindex display-grayscale-p |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1716 This function returns @code{t} if the screen can display shades of gray. |
27654
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1717 (All color displays can do this.) |
27532
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1718 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1719 |
45744
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1720 @anchor{Display Face Attribute Testing} |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1721 @defun display-supports-face-attributes-p attributes &optional display |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1722 @tindex display-supports-face-attributes-p |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1723 This function returns non-@code{nil} if all the face attributes in |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1724 @var{attributes} are supported (@pxref{Face Attributes}). |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1725 |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1726 The definition of `supported' is somewhat heuristic, but basically |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1727 means that a face containing all the attributes in @var{attributes}, |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1728 when merged with the default face for display, can be represented in a |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1729 way that's |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1730 |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1731 @enumerate |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1732 @item |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1733 different in appearance than the default face, and |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1734 |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1735 @item |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1736 `close in spirit' to what the attributes specify, if not exact. |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1737 @end enumerate |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1738 |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1739 Point (2) implies that a @code{:weight black} attribute will be |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1740 satisfied by any display that can display bold, as will |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1741 @code{:foreground "yellow"} as long as some yellowish color can be |
45865
08e62ca55f2c
(Display Feature Testing): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents:
45779
diff
changeset
|
1742 displayed, but @code{:slant italic} will @emph{not} be satisfied by |
45744
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1743 the tty display code's automatic substitution of a `dim' face for |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1744 italic. |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1745 @end defun |
75e9d527da2b
display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents:
44693
diff
changeset
|
1746 |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1747 @defun display-selections-p &optional display |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1748 @tindex display-selections-p |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1749 This function returns @code{t} if @var{display} supports selections. |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1750 Windowed displays normally support selections, but they may also be |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1751 supported in some other cases. |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1752 @end defun |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1753 |
39197
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1754 @defun display-images-p &optional display |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1755 This function returns @code{t} if @var{display} can display images. |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1756 Windowed displays ought in principle to handle images, but some |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1757 systems lack the support for that. On a display that does not support |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39197
diff
changeset
|
1758 images, Emacs cannot display a tool bar. |
39197
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1759 @end defun |
f56fa34012c0
(Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents:
36348
diff
changeset
|
1760 |
27532
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1761 @defun display-screens &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1762 @tindex display-screens |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1763 This function returns the number of screens associated with the display. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1764 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1765 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1766 @defun display-pixel-height &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1767 @tindex display-pixel-height |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1768 This function returns the height of the screen in pixels. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1769 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1770 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1771 @defun display-mm-height &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1772 @tindex display-mm-height |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1773 This function returns the height of the screen in millimeters, |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1774 or @code{nil} if Emacs cannot get that information. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1775 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1776 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1777 @defun display-pixel-width &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1778 @tindex display-pixel-width |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1779 This function returns the width of the screen in pixels. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1780 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1781 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1782 @defun display-mm-width &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1783 @tindex display-mm-width |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1784 This function returns the width of the screen in millimeters, |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1785 or @code{nil} if Emacs cannot get that information. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1786 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1787 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1788 @defun display-backing-store &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1789 @tindex display-backing-store |
27654
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1790 This function returns the backing store capability of the display. |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1791 Backing store means recording the pixels of windows (and parts of |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1792 windows) that are not exposed, so that when exposed they can be |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1793 displayed very quickly. |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1794 |
27532
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1795 Values can be the symbols @code{always}, @code{when-mapped}, or |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1796 @code{not-useful}. The function can also return @code{nil} |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1797 when the question is inapplicable to a certain kind of display. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1798 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1799 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1800 @defun display-save-under &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1801 @tindex display-save-under |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1802 This function returns non-@code{nil} if the display supports the |
27654
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1803 SaveUnder feature. That feature is used by pop-up windows |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1804 to save the pixels they obscure, so that they can pop down |
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1805 quickly. |
27532
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1806 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1807 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1808 @defun display-planes &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1809 @tindex display-planes |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1810 This function returns the number of planes the display supports. |
27654
cabb1b4c4424
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27532
diff
changeset
|
1811 This is typically the number of bits per pixel. |
35037 | 1812 For a tty display, it is log to base two of the number of colours supported. |
27532
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1813 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1814 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1815 @defun display-visual-class &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1816 @tindex display-visual-class |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1817 This function returns the visual class for the screen. The value is one |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1818 of the symbols @code{static-gray}, @code{gray-scale}, |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1819 @code{static-color}, @code{pseudo-color}, @code{true-color}, and |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1820 @code{direct-color}. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1821 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1822 |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1823 @defun display-color-cells &optional display |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1824 @tindex display-color-cells |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1825 This function returns the number of color cells the screen supports. |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1826 @end defun |
ada257a7df9f
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27447
diff
changeset
|
1827 |
27447
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1828 These functions obtain additional information specifically |
ef387684dc33
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
1829 about X displays. |
6547 | 1830 |
12067 | 1831 @defun x-server-version &optional display |
1832 This function returns the list of version numbers of the X server | |
1833 running the display. | |
6547 | 1834 @end defun |
1835 | |
12067 | 1836 @defun x-server-vendor &optional display |
1837 This function returns the vendor that provided the X server software. | |
6547 | 1838 @end defun |
1839 | |
1840 @ignore | |
1841 @defvar x-no-window-manager | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1842 This variable's value is @code{t} if no X window manager is in use. |
6547 | 1843 @end defvar |
1844 @end ignore | |
1845 | |
1846 @ignore | |
1847 @item | |
1848 The functions @code{x-pixel-width} and @code{x-pixel-height} return the | |
1849 width and height of an X Window frame, measured in pixels. | |
1850 @end ignore |