annotate man/lispref/frames.texi @ 404:2f8bb876ab1d r21-2-32

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