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