annotate man/lispref/frames.texi @ 412:697ef44129c6 r21-2-14

Import from CVS: tag r21-2-14
author cvs
date Mon, 13 Aug 2007 11:20:41 +0200
parents 2f8bb876ab1d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @c Copyright (C) 1995, 1996 Ben Wing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 @c See the file lispref.texi for copying conditions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @setfilename ../../info/frames.info
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @node Frames, Consoles and Devices, Windows, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @chapter Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 @cindex frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 A @var{frame} is a rectangle on the screen that contains one or more
412
697ef44129c6 Import from CVS: tag r21-2-14
cvs
parents: 404
diff changeset
12 XEmacs windows. A frame initially contains a single main window (plus
697ef44129c6 Import from CVS: tag r21-2-14
cvs
parents: 404
diff changeset
13 perhaps a minibuffer window), which you can subdivide vertically or
697ef44129c6 Import from CVS: tag r21-2-14
cvs
parents: 404
diff changeset
14 horizontally into smaller windows.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 @cindex terminal frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 @cindex X window frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 When XEmacs runs on a text-only terminal, it starts with one
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 @dfn{TTY frame}. If you create additional ones, XEmacs displays
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 one and only one at any given time---on the terminal screen, of course.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 When XEmacs communicates directly with an X server, it does not have a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 TTY frame; instead, it starts with a single @dfn{X window frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 It can display multiple X window frames at the same time, each in its
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 own X window.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 @defun framep object
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 This predicate returns @code{t} if @var{object} is a frame, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 @code{nil} otherwise.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 * Creating Frames:: Creating additional frames.
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
34 * Frame Properties:: Controlling frame size, position, font, etc.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 * Frame Titles:: Automatic updating of frame titles.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 * Deleting Frames:: Frames last until explicitly deleted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 * Finding All Frames:: How to examine all existing frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 * Frames and Windows:: A frame contains windows;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 display of text always works through windows.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 * Minibuffers and Frames:: How a frame finds the minibuffer to use.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 * Input Focus:: Specifying the selected frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 * Visibility of Frames:: Frames may be visible or invisible, or icons.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 * Raising and Lowering:: Raising a frame makes it hide other X windows;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 lowering it makes the others hide them.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 * Frame Configurations:: Saving the state of all frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 * Frame Hooks:: Hooks for customizing frame behavior.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 @xref{Display}, for related information.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 @node Creating Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 @section Creating Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 To create a new frame, call the function @code{make-frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
56 @defun make-frame &optional props device
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 This function creates a new frame on @var{device}, if @var{device}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 permits creation of frames. (An X server does; an ordinary terminal
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
59 does not (yet).) @var{device} defaults to the selected device if omitted.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 @xref{Consoles and Devices}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
62 The argument @var{props} is a property list (a list of alternating
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
63 keyword-value specifications) of properties for the new frame. (An alist
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
64 is accepted for backward compatibility but should not be passed in.) Any
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
65 properties not mentioned in @var{props} default according to the value
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
66 of the variable @code{default-frame-plist}. For X devices, properties
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
67 not specified in @code{default-frame-plist} default in turn from
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
68 @code{default-x-frame-plist} and, if not specified there, from the X
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
69 resources. For TTY devices, @code{default-tty-frame-plist} is consulted
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
70 as well as @code{default-frame-plist}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
72 The set of possible properties depends in principle on what kind of
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 window system XEmacs uses to display its frames. @xref{X Frame
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
74 Properties}, for documentation of individual properties you can specify
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 when creating an X window frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
78 @node Frame Properties
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
79 @section Frame Properties
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
81 A frame has many properties that control its appearance and behavior.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
82 Just what properties a frame has depends on which display mechanism it
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 uses.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
85 Frame properties exist for the sake of window systems. A terminal frame
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
86 has few properties, mostly for compatibility's sake; only the height,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
87 width and @code{buffer-predicate} properties really do something.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 @menu
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
90 * Property Access:: How to change a frame's properties.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
91 * Initial Properties:: Specifying frame properties when you make a frame.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
92 * X Frame Properties:: List of frame properties.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
93 * Size and Position:: Changing the size and position of a frame.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
94 * Frame Name:: The name of a frame (as opposed to its title).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
97 @node Property Access
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
98 @subsection Access to Frame Properties
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
99
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
100 These functions let you read and change the properties of a frame.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
102 @defun frame-properties &optional frame
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
103 This function returns a plist listing all the properties of @var{frame}
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
104 and their values.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
105 @end defun
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
107 @defun frame-property frame property &optional default
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
108 This function returns @var{frame}'s value for the property
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
109 @var{property}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
112 @defun set-frame-properties frame plist
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
113 This function alters the properties of frame @var{frame} based on the
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
114 elements of property list @var{plist}. If you don't mention a property
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
115 in @var{plist}, its value doesn't change.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
116 @end defun
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
117
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
118 @defun set-frame-property frame prop val
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
119 This function sets the property @var{prop} of frame @var{frame} to the
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
120 value @var{val}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
123 @node Initial Properties
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
124 @subsection Initial Frame Properties
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
126 You can specify the properties for the initial startup frame by setting
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
127 @code{initial-frame-plist} in your @file{.emacs} file.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
129 @defvar initial-frame-plist
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
130 This variable's value is a plist of alternating property-value pairs
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
131 used when creating the initial X window frame.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
133 XEmacs creates the initial frame before it reads your @file{~/.emacs}
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
134 file. After reading that file, XEmacs checks @code{initial-frame-plist},
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
135 and applies the property settings in the altered value to the already
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136 created initial frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 If these settings affect the frame geometry and appearance, you'll see
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 the frame appear with the wrong ones and then change to the specified
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 ones. If that bothers you, you can specify the same geometry and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141 appearance with X resources; those do take affect before the frame is
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
142 created. @xref{Resources X,, X Resources, xemacs, The XEmacs User's Manual}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 X resource settings typically apply to all frames. If you want to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 specify some X resources solely for the sake of the initial frame, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 you don't want them to apply to subsequent frames, here's how to achieve
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
147 this: specify properties in @code{default-frame-plist} to override the X
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
148 resources for subsequent frames; then, to prevent these from affecting
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
149 the initial frame, specify the same properties in
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
150 @code{initial-frame-plist} with values that match the X resources.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
153 If these properties specify a separate minibuffer-only frame via a
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
154 @code{minibuffer} property of @code{nil}, and you have not yet created
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
155 one, XEmacs creates one for you.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
157 @defvar minibuffer-frame-plist
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
158 This variable's value is a plist of properties used when creating an
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
159 initial minibuffer-only frame---if such a frame is needed, according to
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
160 the properties for the main initial frame.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
163 @defvar default-frame-plist
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
164 This is a plist specifying default values of frame properties for
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
165 subsequent XEmacs frames (not the initial ones).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
168 See also @code{special-display-frame-plist}, in @ref{Choosing Window}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
170 If you use options that specify window appearance when you invoke XEmacs,
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
171 they take effect by adding elements to @code{default-frame-plist}. One
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 exception is @samp{-geometry}, which adds the specified position to
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
173 @code{initial-frame-plist} instead. @xref{Command Arguments,,, xemacs,
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 The XEmacs User's Manual}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
176 @node X Frame Properties
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
177 @subsection X Window Frame Properties
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
179 Just what properties a frame has depends on what display mechanism it
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
180 uses. Here is a table of the properties of an X window frame; of these,
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 @code{name}, @code{height}, @code{width}, and @code{buffer-predicate}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182 provide meaningful information in non-X frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 @table @code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185 @item name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 The name of the frame. Most window managers display the frame's name in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 the frame's border, at the top of the frame. If you don't specify a
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
188 name, and you have more than one frame, XEmacs sets the frame name based
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189 on the buffer displayed in the frame's selected window.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
190
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
191 If you specify the frame name explicitly when you create the frame, the
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
192 name is also used (instead of the name of the XEmacs executable) when
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193 looking up X resources for the frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
194
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
195 @item display
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
196 The display on which to open this frame. It should be a string of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
197 form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
198 @code{DISPLAY} environment variable.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
199
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200 @item left
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
201 The screen position of the left edge, in pixels, with respect to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202 left edge of the screen. The value may be a positive number @var{pos},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
203 or a list of the form @code{(+ @var{pos})} which permits specifying a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
204 negative @var{pos} value.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
205
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
206 A negative number @minus{}@var{pos}, or a list of the form @code{(-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
207 @var{pos})}, actually specifies the position of the right edge of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
208 window with respect to the right edge of the screen. A positive value
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
209 of @var{pos} counts toward the left. If the property is a negative
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
210 integer @minus{}@var{pos} then @var{pos} is positive!
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
211
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
212 @item top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
213 The screen position of the top edge, in pixels, with respect to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
214 top edge of the screen. The value may be a positive number @var{pos},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
215 or a list of the form @code{(+ @var{pos})} which permits specifying a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
216 negative @var{pos} value.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
217
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
218 A negative number @minus{}@var{pos}, or a list of the form @code{(-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
219 @var{pos})}, actually specifies the position of the bottom edge of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
220 window with respect to the bottom edge of the screen. A positive value
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
221 of @var{pos} counts toward the top. If the property is a negative
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
222 integer @minus{}@var{pos} then @var{pos} is positive!
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
223
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
224 @item icon-left
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
225 The screen position of the left edge @emph{of the frame's icon}, in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
226 pixels, counting from the left edge of the screen. This takes effect if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
227 and when the frame is iconified.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
228
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
229 @item icon-top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
230 The screen position of the top edge @emph{of the frame's icon}, in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
231 pixels, counting from the top edge of the screen. This takes effect if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
232 and when the frame is iconified.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
233
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
234 @item user-position
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
235 Non-@code{nil} if the screen position of the frame was explicitly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
236 requested by the user (for example, with the @samp{-geometry} option).
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
237 Nothing automatically makes this property non-@code{nil}; it is up to
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
238 Lisp programs that call @code{make-frame} to specify this property as
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
239 well as specifying the @code{left} and @code{top} properties.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
240
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
241 @item height
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
242 The height of the frame contents, in characters. (To get the height in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
243 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
244
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
245 @item width
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
246 The width of the frame contents, in characters. (To get the height in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
247 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
248
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
249 @item window-id
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
250 The number of the X window for the frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
251
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
252 @item minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
253 Whether this frame has its own minibuffer. The value @code{t} means
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
254 yes, @code{nil} means no, @code{only} means this frame is just a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
255 minibuffer. If the value is a minibuffer window (in some other frame),
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
256 the new frame uses that minibuffer. (Minibuffer-only and minibuffer-less
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
257 frames are not yet implemented in XEmacs.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
258
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
259 @item buffer-predicate
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
260 The buffer-predicate function for this frame. The function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
261 @code{other-buffer} uses this predicate (from the selected frame) to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
262 decide which buffers it should consider, if the predicate is not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
263 @code{nil}. It calls the predicate with one arg, a buffer, once for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
264 each buffer; if the predicate returns a non-@code{nil} value, it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
265 considers that buffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
266
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
267 @item scroll-bar-width
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
268 The width of the vertical scroll bar, in pixels.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
269
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
270 @ignore Not in XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
271 @item icon-type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
272 The type of icon to use for this frame when it is iconified. If the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
273 value is a string, that specifies a file containing a bitmap to use.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
274 Any other non-@code{nil} value specifies the default bitmap icon (a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
275 picture of a gnu); @code{nil} specifies a text icon.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
276
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
277 @item icon-name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
278 The name to use in the icon for this frame, when and if the icon
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
279 appears. If this is @code{nil}, the frame's title is used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
280 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
281
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
282 @item cursor-color
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
283 The color for the cursor that shows point.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
284
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
285 @item border-color
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
286 The color for the border of the frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
287
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
288 @ignore Not in XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
289 @item cursor-type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
290 The way to display the cursor. The legitimate values are @code{bar},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
291 @code{box}, and @code{(bar . @var{width})}. The symbol @code{box}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
292 specifies an ordinary black box overlaying the character after point;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
293 that is the default. The symbol @code{bar} specifies a vertical bar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
294 between characters as the cursor. @code{(bar . @var{width})} specifies
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
295 a bar @var{width} pixels wide.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
296 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
297
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
298 @item border-width
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
299 The width in pixels of the window border.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
300
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
301 @item internal-border-width
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
302 The distance in pixels between text and border.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
303
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
304 @item unsplittable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
305 If non-@code{nil}, this frame's window is never split automatically.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
306
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
307 @item inter-line-space
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
308 The space in pixels between adjacent lines of text. (Not currently
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
309 implemented.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
310
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
311 @item modeline
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
312 Whether the frame has a modeline.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
313 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
314
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
315 @node Size and Position
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
316 @subsection Frame Size And Position
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
317 @cindex size of frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
318 @cindex frame size
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
319 @cindex display lines
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
320 @cindex display columns
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
321 @cindex resize redisplay
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
322 @cindex frame position
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
323 @cindex position of frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
324
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
325 You can read or change the size and position of a frame using the
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
326 frame properties @code{left}, @code{top}, @code{height}, and
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
327 @code{width}. Whatever geometry properties you don't specify are chosen
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
328 by the window manager in its usual fashion.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
329
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
330 Here are some special features for working with sizes and positions:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
331
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
332 @defun set-frame-position frame left top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
333 This function sets the position of the top left corner of @var{frame} to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
334 @var{left} and @var{top}. These arguments are measured in pixels, and
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
335 count from the top left corner of the screen. Negative property values
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
336 count up or rightward from the top left corner of the screen.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
337 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
338
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
339 @defun frame-height &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
340 @defunx frame-width &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
341 These functions return the height and width of @var{frame}, measured in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
342 lines and columns. If you don't supply @var{frame}, they use the selected
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
343 frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
344 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
345
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
346 @defun frame-pixel-height &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
347 @defunx frame-pixel-width &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
348 These functions return the height and width of @var{frame}, measured in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
349 pixels. If you don't supply @var{frame}, they use the selected frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
350 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
351
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
352 @defun set-frame-size frame cols rows &optional pretend
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
353 This function sets the size of @var{frame}, measured in characters;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
354 @var{cols} and @var{rows} specify the new width and height. (If
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
355 @var{pretend} is non-nil, it means that redisplay should act as if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
356 the frame's size is @var{cols} by @var{rows}, but the actual size
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
357 of the frame should not be changed. You should not normally use
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
358 this option.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
359 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
360
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
361 You can also use the functions @code{set-frame-height} and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
362 @code{set-frame-width} to set the height and width individually.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
363 The frame is the first argument and the size (in rows or columns)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
364 is the second. (There is an optional third argument, @var{pretend},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
365 which has the same purpose as the corresponding argument in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
366 @code{set-frame-size}.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
367
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
368 @ignore @c Not in XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
369 @defun x-parse-geometry geom
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
370 @cindex geometry specification
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
371 The function @code{x-parse-geometry} converts a standard X windows
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
372 geometry string to a plist that you can use as part of the argument to
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
373 @code{make-frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
374
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
375 The plist describes which properties were specified in @var{geom}, and
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
376 gives the values specified for them. Each element looks like
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
377 @code{(@var{property} . @var{value})}. The possible @var{property}
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
378 values are @code{left}, @code{top}, @code{width}, and @code{height}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
379
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
380 For the size properties, the value must be an integer. The position
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
381 property names @code{left} and @code{top} are not totally accurate,
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
382 because some values indicate the position of the right or bottom edges
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
383 instead. These are the @var{value} possibilities for the position
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
384 properties:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
385
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
386 @table @asis
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
387 @item an integer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
388 A positive integer relates the left edge or top edge of the window to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
389 the left or top edge of the screen. A negative integer relates the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
390 right or bottom edge of the window to the right or bottom edge of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
391 screen.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
392
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
393 @item @code{(+ @var{position})}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
394 This specifies the position of the left or top edge of the window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
395 relative to the left or top edge of the screen. The integer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
396 @var{position} may be positive or negative; a negative value specifies a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
397 position outside the screen.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
398
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
399 @item @code{(- @var{position})}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
400 This specifies the position of the right or bottom edge of the window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
401 relative to the right or bottom edge of the screen. The integer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
402 @var{position} may be positive or negative; a negative value specifies a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
403 position outside the screen.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
404 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
405
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
406 Here is an example:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
407
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
408 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
409 (x-parse-geometry "35x70+0-0")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
410 @result{} ((width . 35) (height . 70)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
411 (left . 0) (top - 0))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
412 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
413 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
414 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
415
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
416 @node Frame Name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
417 @subsection The Name of a Frame (As Opposed to Its Title)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
418 @cindex frame name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
419
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
420 Under X, every frame has a name, which is not the same as the title of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
421 the frame. A frame's name is used to look up its resources and does
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
422 not normally change over the lifetime of a frame. It is perfectly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
423 allowable, and quite common, for multiple frames to have the same
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
424 name.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
425
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
426 @defun frame-name &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
427 This function returns the name of @var{frame}, which defaults to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
428 selected frame if not specified. The name of a frame can also be
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
429 obtained from the frame's properties. @xref{Frame Properties}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
430 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
431
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
432 @defvar default-frame-name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
433 This variable holds the default name to assign to newly-created frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
434 This can be overridden by arguments to @code{make-frame}. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
435 must be a string.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
436 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
437
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
438 @node Frame Titles
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
439 @section Frame Titles
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
440
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
441 Every frame has a title; most window managers display the frame title at
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
442 the top of the frame. You can specify an explicit title with the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
443 @code{name} frame property. But normally you don't specify this
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
444 explicitly, and XEmacs computes the title automatically.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
445
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
446 XEmacs computes the frame title based on a template stored in the
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
447 variable @code{frame-title-format}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
448
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
449 @defvar frame-title-format
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
450 This variable specifies how to compute a title for a frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
451 when you have not explicitly specified one.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
452
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
453 The variable's value is actually a modeline construct, just like
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
454 @code{modeline-format}. @xref{Modeline Data}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
455 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
456
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
457 @defvar frame-icon-title-format
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
458 This variable specifies how to compute the title for an iconified frame,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
459 when you have not explicitly specified the frame title. This title
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
460 appears in the icon itself.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
461 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
462
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
463 @defun x-set-frame-icon-pixmap frame pixmap &optional mask
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
464 This function sets the icon of the given frame to the given image
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
465 instance, which should be an image instance object (as returned by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
466 @code{make-image-instance}), a glyph object (as returned by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
467 @code{make-glyph}), or @code{nil}. If a glyph object is given, the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
468 glyph will be instantiated on the frame to produce an image instance
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
469 object.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
470
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
471 If the given image instance has a mask, that will be used as the icon mask;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
472 however, not all window managers support this.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
473
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
474 The window manager is also not required to support color pixmaps,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
475 only bitmaps (one plane deep).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
476
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
477 If the image instance does not have a mask, then the optional
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
478 third argument may be the image instance to use as the mask (it must be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
479 one plane deep).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
480 @xref{Glyphs}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
481 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
482
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
483 @node Deleting Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
484 @section Deleting Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
485 @cindex deletion of frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
486
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
487 Frames remain potentially visible until you explicitly @dfn{delete}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
488 them. A deleted frame cannot appear on the screen, but continues to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
489 exist as a Lisp object until there are no references to it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
490
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
491 @deffn Command delete-frame &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
492 This function deletes the frame @var{frame}. By default, @var{frame} is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
493 the selected frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
494 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
495
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
496 @defun frame-live-p frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
497 The function @code{frame-live-p} returns non-@code{nil} if the frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
498 @var{frame} has not been deleted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
499 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
500
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
501 @ignore Not in XEmacs currently
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
502 Some window managers provide a command to delete a window. These work
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
503 by sending a special message to the program that operates the window.
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
504 When XEmacs gets one of these commands, it generates a
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
505 @code{delete-frame} event, whose normal definition is a command that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
506 calls the function @code{delete-frame}. @xref{Misc Events}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
507 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
508
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
509 @node Finding All Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
510 @section Finding All Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
511
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
512 @defun frame-list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
513 The function @code{frame-list} returns a list of all the frames that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
514 have not been deleted. It is analogous to @code{buffer-list} for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
515 buffers. The list that you get is newly created, so modifying the list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
516 doesn't have any effect on the internals of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
517 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
518
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
519 @defun device-frame-list &optional device
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
520 This function returns a list of all frames on @var{device}. If
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
521 @var{device} is @code{nil}, the selected device will be used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
522 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
523
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
524 @defun visible-frame-list &optional device
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
525 This function returns a list of just the currently visible frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
526 If @var{device} is specified only frames on that device will be returned.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
527 @xref{Visibility of Frames}. (TTY frames always count as
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
528 ``visible'', even though only the selected one is actually displayed.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
529 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
530
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
531 @defun next-frame &optional frame minibuf
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
532 The function @code{next-frame} lets you cycle conveniently through all
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
533 the frames from an arbitrary starting point. It returns the ``next''
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
534 frame after @var{frame} in the cycle. If @var{frame} is omitted or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
535 @code{nil}, it defaults to the selected frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
536
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
537 The second argument, @var{minibuf}, says which frames to consider:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
538
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
539 @table @asis
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
540 @item @code{nil}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
541 Exclude minibuffer-only frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
542 @item @code{visible}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
543 Consider all visible frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
544 @item 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
545 Consider all visible or iconified frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
546 @item a window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
547 Consider only the frames using that particular window as their
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
548 minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
549 @item the symbol @code{visible}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
550 Include all visible frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
551 @item @code{0}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
552 Include all visible and iconified frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
553 @item anything else
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
554 Consider all frames.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
555 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
556 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
557
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
558 @defun previous-frame &optional frame minibuf
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
559 Like @code{next-frame}, but cycles through all frames in the opposite
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
560 direction.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
561 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
562
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
563 See also @code{next-window} and @code{previous-window}, in @ref{Cyclic
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
564 Window Ordering}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
565
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
566 @node Frames and Windows
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
567 @section Frames and Windows
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
568
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
569 Each window is part of one and only one frame; you can get the frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
570 with @code{window-frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
571
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
572 @defun frame-root-window &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
573 This returns the root window of frame @var{frame}. @var{frame}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
574 defaults to the selected frame if not specified.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
575 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
576
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
577 @defun window-frame &optional window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
578 This function returns the frame that @var{window} is on. @var{window}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
579 defaults to the selected window if omitted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
580 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
581
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
582 All the non-minibuffer windows in a frame are arranged in a cyclic
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
583 order. The order runs from the frame's top window, which is at the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
584 upper left corner, down and to the right, until it reaches the window at
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
585 the lower right corner (always the minibuffer window, if the frame has
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
586 one), and then it moves back to the top.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
587
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
588 @defun frame-top-window frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
589 This returns the topmost, leftmost window of frame @var{frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
590 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
591
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
592 At any time, exactly one window on any frame is @dfn{selected within the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
593 frame}. The significance of this designation is that selecting the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
594 frame also selects this window. You can get the frame's current
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
595 selected window with @code{frame-selected-window}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
596
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
597 @defun frame-selected-window &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
598 This function returns the window on @var{frame} that is selected within
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
599 @var{frame}. @var{frame} defaults to the selected frame if not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
600 specified.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
601 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
602
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
603 Conversely, selecting a window for XEmacs with @code{select-window} also
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
604 makes that window selected within its frame. @xref{Selecting Windows}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
605
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
606 Another function that (usually) returns one of the windows in a frame is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
607 @code{minibuffer-window}. @xref{Minibuffer Misc}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
608
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
609 @node Minibuffers and Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
610 @section Minibuffers and Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
611
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
612 Normally, each frame has its own minibuffer window at the bottom, which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
613 is used whenever that frame is selected. If the frame has a minibuffer,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
614 you can get it with @code{minibuffer-window} (@pxref{Minibuffer Misc}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
615
2
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
616 However, you can also create a frame with no minibuffer. Such a frame
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
617 must use the minibuffer window of some other frame. When you create the
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
618 frame, you can specify explicitly the minibuffer window to use (in some
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
619 other frame). If you don't, then the minibuffer is found in the frame
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
620 which is the value of the variable @code{default-minibuffer-frame}. Its
ac2d302a0011 Import from CVS: tag r19-15b2
cvs
parents: 0
diff changeset
621 value should be a frame which does have a minibuffer.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
622
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
623 @ignore Not yet in XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
624 If you use a minibuffer-only frame, you might want that frame to raise
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
625 when you enter the minibuffer. If so, set the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
626 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
627 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
628
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
629 @defvar default-minibuffer-frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
630 This variable specifies the frame to use for the minibuffer window, by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
631 default.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
632 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
633
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
634 @node Input Focus
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
635 @section Input Focus
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
636 @cindex input focus
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
637 @cindex selected frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
638
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
639 At any time, one frame in XEmacs is the @dfn{selected frame}. The selected
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
640 window always resides on the selected frame. As the focus moves from
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
641 device to device, the selected frame on each device is remembered and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
642 restored when the focus moves back to that device.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
643
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
644 @defun selected-frame &optional device
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
645 This function returns the selected frame on @var{device}. If
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
646 @var{device} is not specified, the selected device will be used. If no
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
647 frames exist on the device, @code{nil} is returned.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
648 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
649
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
650 The X server normally directs keyboard input to the X window that the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
651 mouse is in. Some window managers use mouse clicks or keyboard events
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
652 to @dfn{shift the focus} to various X windows, overriding the normal
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
653 behavior of the server.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
654
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
655 Lisp programs can switch frames ``temporarily'' by calling
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
656 the function @code{select-frame}. This does not override the window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
657 manager; rather, it escapes from the window manager's control until
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
658 that control is somehow reasserted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
659
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
660 When using a text-only terminal, there is no window manager; therefore,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
661 @code{select-frame} is the only way to switch frames, and the effect
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
662 lasts until overridden by a subsequent call to @code{select-frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
663 Only the selected terminal frame is actually displayed on the terminal.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
664 Each terminal screen except for the initial one has a number, and the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
665 number of the selected frame appears in the mode line after the word
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
666 @samp{XEmacs} (@pxref{Modeline Variables}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
667
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
668 @defun select-frame frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
669 This function selects frame @var{frame}, temporarily disregarding the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
670 focus of the X server if any. The selection of @var{frame} lasts until
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
671 the next time the user does something to select a different frame, or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
672 until the next time this function is called.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
673
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
674 Note that @code{select-frame} does not actually cause the window-system
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
675 focus to be set to this frame, or the @code{select-frame-hook} or
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
676 @code{deselect-frame-hook} to be run, until the next time that XEmacs is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
677 waiting for an event.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
678
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
679 Also note that when the variable @code{focus-follows-mouse} is
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
680 non-@code{nil}, the frame selection is temporary and is reverted when
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
681 the current command terminates, much like the buffer selected by
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
682 @code{set-buffer}. In order to effect a permanent focus change use
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
683 @code{focus-frame}.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
684 @end defun
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
685
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
686 @defun focus-frame frame
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
687 This function selects @var{frame} and gives it the window system focus.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
688 The operation of @code{focus-frame} is not affected by the value of
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
689 @code{focus-follows-mouse}.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
690 @end defun
280
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 54
diff changeset
691
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
692 @defmac save-selected-frame forms@dots{}
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
693 This macro records the selected frame, executes @var{forms} in sequence,
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
694 then restores the earlier selected frame. The value returned is the
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
695 value of the last form.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
696 @end defmac
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
697
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
698 @defmac with-selected-frame frame forms@dots{}
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
699 This macro records the selected frame, then selects @var{frame} and
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
700 executes @var{forms} in sequence. After the last form is finished, the
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
701 earlier selected frame is restored. The value returned is the value of
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
702 the last form.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
703 @end defmac
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
704
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
705 @ignore (FSF Emacs, continued from defun select-frame)
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
706 XEmacs cooperates with the X server and the window managers by arranging
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
707 to select frames according to what the server and window manager ask
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
708 for. It does so by generating a special kind of input event, called a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
709 @dfn{focus} event. The command loop handles a focus event by calling
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
710 @code{handle-select-frame}. @xref{Focus Events}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
711
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
712 @deffn Command handle-switch-frame frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
713 This function handles a focus event by selecting frame @var{frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
714
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
715 Focus events normally do their job by invoking this command.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
716 Don't call it for any other reason.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
717 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
718
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
719 @defun redirect-frame-focus frame focus-frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
720 This function redirects focus from @var{frame} to @var{focus-frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
721 This means that @var{focus-frame} will receive subsequent keystrokes
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
722 intended for @var{frame}. After such an event, the value of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
723 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
724 events specifying @var{frame} will instead select @var{focus-frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
725
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
726 If @var{focus-frame} is @code{nil}, that cancels any existing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
727 redirection for @var{frame}, which therefore once again receives its own
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
728 events.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
729
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
730 One use of focus redirection is for frames that don't have minibuffers.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
731 These frames use minibuffers on other frames. Activating a minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
732 on another frame redirects focus to that frame. This puts the focus on
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
733 the minibuffer's frame, where it belongs, even though the mouse remains
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
734 in the frame that activated the minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
735
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
736 Selecting a frame can also change focus redirections. Selecting frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
737 @code{bar}, when @code{foo} had been selected, changes any redirections
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
738 pointing to @code{foo} so that they point to @code{bar} instead. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
739 allows focus redirection to work properly when the user switches from
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
740 one frame to another using @code{select-window}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
741
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
742 This means that a frame whose focus is redirected to itself is treated
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
743 differently from a frame whose focus is not redirected.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
744 @code{select-frame} affects the former but not the latter.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
745
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
746 The redirection lasts until @code{redirect-frame-focus} is called to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
747 change it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
748 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
749 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
750
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
751 @node Visibility of Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
752 @section Visibility of Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
753 @cindex visible frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
754 @cindex invisible frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
755 @cindex iconified frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
756 @cindex frame visibility
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
757
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
758 An X window frame may be @dfn{visible}, @dfn{invisible}, or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
759 @dfn{iconified}. If it is visible, you can see its contents. If it is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
760 iconified, the frame's contents do not appear on the screen, but an icon
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
761 does. If the frame is invisible, it doesn't show on the screen, not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
762 even as an icon.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
763
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
764 Visibility is meaningless for TTY frames, since only the selected
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
765 one is actually displayed in any case.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
766
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
767 @deffn Command make-frame-visible &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
768 This function makes frame @var{frame} visible. If you omit @var{frame},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
769 it makes the selected frame visible.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
770 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
771
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
772 @deffn Command make-frame-invisible &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
773 This function makes frame @var{frame} invisible.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
774 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
775
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
776 @deffn Command iconify-frame &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
777 This function iconifies frame @var{frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
778 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
779
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
780 @deffn Command deiconify-frame &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
781 This function de-iconifies frame @var{frame}. Under X, this is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
782 equivalent to @code{make-frame-visible}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
783 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
784
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
785 @defun frame-visible-p frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
786 This returns whether @var{frame} is currently ``visible'' (actually in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
787 use for display). A frame that is not visible is not updated, and, if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
788 it works through a window system, may not show at all.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
789 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
790
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
791 @defun frame-iconified-p frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
792 This returns whether @var{frame} is iconified. Not all window managers
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
793 use icons; some merely unmap the window, so this function is not the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
794 inverse of @code{frame-visible-p}. It is possible for a frame to not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
795 be visible and not be iconified either. However, if the frame is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
796 iconified, it will not be visible. (Under FSF Emacs, the functionality
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
797 of this function is obtained through @code{frame-visible-p}.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
798 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
799
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
800 @defun frame-totally-visible-p frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
801 This returns whether @var{frame} is not obscured by any other X
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
802 windows. On TTY frames, this is the same as @code{frame-visible-p}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
803 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
804
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
805 @ignore @c Not in XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
806 The visibility status of a frame is also available as a frame
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
807 property. You can read or change it as such. @xref{X Frame
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
808 Properties}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
809
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
810 The user can iconify and deiconify frames with the window manager. This
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
811 happens below the level at which XEmacs can exert any control, but XEmacs
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
812 does provide events that you can use to keep track of such changes.
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
813 @xref{Misc Events}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
814 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
815
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
816 @node Raising and Lowering
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
817 @section Raising and Lowering Frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
818
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
819 The X Window System uses a desktop metaphor. Part of this metaphor is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
820 the idea that windows are stacked in a notional third dimension
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
821 perpendicular to the screen surface, and thus ordered from ``highest''
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
822 to ``lowest''. Where two windows overlap, the one higher up covers the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
823 one underneath. Even a window at the bottom of the stack can be seen if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
824 no other window overlaps it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
825
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
826 @cindex raising a frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
827 @cindex lowering a frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
828 A window's place in this ordering is not fixed; in fact, users tend to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
829 change the order frequently. @dfn{Raising} a window means moving it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
830 ``up'', to the top of the stack. @dfn{Lowering} a window means moving
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
831 it to the bottom of the stack. This motion is in the notional third
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
832 dimension only, and does not change the position of the window on the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
833 screen.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
834
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
835 You can raise and lower XEmacs's X windows with these functions:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
836
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
837 @deffn Command raise-frame &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
838 This function raises frame @var{frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
839 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
840
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
841 @deffn Command lower-frame &optional frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
842 This function lowers frame @var{frame}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
843 @end deffn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
844
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
845 You can also specify auto-raise (raising automatically when a frame is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
846 selected) or auto-lower (lowering automatically when it is deselected).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
847 Under X, most ICCCM-compliant window managers will have an option to do
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
848 this for you, but the following variables are provided in case you're
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
849 using a broken WM. (Under FSF Emacs, the same functionality is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
850 provided through the @code{auto-raise} and @code{auto-lower}
54
05472e90ae02 Import from CVS: tag r19-16-pre2
cvs
parents: 2
diff changeset
851 frame properties.)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
852
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
853 @defvar auto-raise-frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
854 This variable's value is @code{t} if frames will be raised to the top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
855 when selected.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
856 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
857
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
858 @ignore Not in XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
859 @defopt minibuffer-auto-raise
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
860 If this is non-@code{nil}, activation of the minibuffer raises the frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
861 that the minibuffer window is in.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
862 @end defopt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
863 @end ignore
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
864
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
865 @defvar auto-lower-frame
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
866 This variable's value is @code{t} if frames will be lowered to the bottom
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
867 when no longer selected.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
868 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
869
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
870 Auto-raising and auto-lowering is implemented through functions attached
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
871 to @code{select-frame-hook} and @code{deselect-frame-hook}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
872 (@pxref{Frame Hooks}). Under normal circumstances, you should not call
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
873 these functions directly.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
874
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
875 @defun default-select-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
876 This hook function implements the @code{auto-raise-frame} variable; it is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
877 for use as the value of @code{select-frame-hook}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
878 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
879
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
880 @defun default-deselect-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
881 This hook function implements the @code{auto-lower-frame} variable; it is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
882 for use as the value of @code{deselect-frame-hook}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
883 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
884
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
885 @node Frame Configurations
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
886 @section Frame Configurations
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
887 @cindex frame configuration
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
888
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
889 A @dfn{frame configuration} records the current arrangement of frames,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
890 all their properties, and the window configuration of each one.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
891
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
892 @defun current-frame-configuration
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
893 This function returns a frame configuration list that describes
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
894 the current arrangement of frames and their contents.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
895 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
896
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
897 @defun set-frame-configuration configuration
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
898 This function restores the state of frames described in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
899 @var{configuration}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
900 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
901
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
902 @node Frame Hooks
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
903 @section Hooks for Customizing Frame Behavior
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
904 @cindex frame hooks
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
905
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
906 XEmacs provides many hooks that are called at various times during a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
907 frame's lifetime. @xref{Hooks}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
908
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
909 @defvar create-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
910 This hook is called each time a frame is created. The functions are called
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
911 with one argument, the newly-created frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
912 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
913
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
914 @defvar delete-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
915 This hook is called each time a frame is deleted. The functions are called
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
916 with one argument, the about-to-be-deleted frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
917 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
918
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
919 @defvar select-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
920 This is a normal hook that is run just after a frame is selected. The
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
921 function @code{default-select-frame-hook}, which implements auto-raising
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
922 (@pxref{Raising and Lowering}), is normally attached to this hook.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
923
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
924 Note that calling @code{select-frame} does not necessarily set the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
925 focus: The actual window-system focus will not be changed until the next
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
926 time that XEmacs is waiting for an event, and even then, the window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
927 manager may refuse the focus-change request.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
928 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
929
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
930 @defvar deselect-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
931 This is a normal hook that is run just before a frame is deselected
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
932 (and another frame is selected). The function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
933 @code{default-deselect-frame-hook}, which implements auto-lowering
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
934 (@pxref{Raising and Lowering}), is normally attached to this hook.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
935 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
936
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
937 @defvar map-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
938 This hook is called each time a frame is mapped (i.e. made visible).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
939 The functions are called with one argument, the newly mapped frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
940 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
941
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
942 @defvar unmap-frame-hook
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
943 This hook is called each time a frame is unmapped (i.e. made invisible
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
944 or iconified). The functions are called with one argument, the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
945 newly unmapped frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
946 @end defvar