Initial revision
[emacs.git] / lisp / frame.el
blob509c1347c2dd9ce346f178857f9594f894613f44
1 ;;; frame.el --- multi-frame management independent of window systems.
3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Code:
27 (defvar frame-creation-function nil
28 "Window-system dependent function to call to create a new frame.
29 The window system startup file should set this to its frame creation
30 function, which should take an alist of parameters as its argument.")
32 ;;; The initial value given here for this must ask for a minibuffer.
33 ;;; There must always exist a frame with a minibuffer, and after we
34 ;;; delete the terminal frame, this will be the only frame.
35 (defvar initial-frame-alist '((minibuffer . t))
36 "Alist of frame parameters for creating the initial X window frame.
37 You can set this in your `.emacs' file; for example,
38 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
39 Parameters specified here supersede the values given in `default-frame-alist'.
41 If the value calls for a frame without a minibuffer, and you have not created
42 a minibuffer frame on your own, one is created according to
43 `minibuffer-frame-alist'.
45 You can specify geometry-related options for just the initial frame
46 by setting this variable in your `.emacs' file; however, they won't
47 take effect until Emacs reads `.emacs', which happens after first creating
48 the frame. If you want the frame to have the proper geometry as soon
49 as it appears, you need to use this three-step process:
50 * Specify X resources to give the geometry you want.
51 * Set `default-frame-alist' to override these options so that they
52 don't affect subsequent frames.
53 * Set `initial-frame-alist' in a way that matches the X resources,
54 to override what you put in `default-frame-alist'.")
56 (defvar minibuffer-frame-alist '((width . 80) (height . 2))
57 "Alist of frame parameters for initially creating a minibuffer frame.
58 You can set this in your `.emacs' file; for example,
59 (setq minibuffer-frame-alist
60 '((top . 1) (left . 1) (width . 80) (height . 2)))
61 Parameters specified here supersede the values given in
62 `default-frame-alist'.")
64 (defvar pop-up-frame-alist nil
65 "Alist of frame parameters used when creating pop-up frames.
66 Pop-up frames are used for completions, help, and the like.
67 This variable can be set in your init file, like this:
68 (setq pop-up-frame-alist '((width . 80) (height . 20)))
69 These supersede the values given in `default-frame-alist'.")
71 (setq pop-up-frame-function
72 (function (lambda ()
73 (make-frame pop-up-frame-alist))))
75 (defvar special-display-frame-alist
76 '((height . 14) (width . 80) (unsplittable . t))
77 "*Alist of frame parameters used when creating special frames.
78 Special frames are used for buffers whose names are in
79 `special-display-buffer-names' and for buffers whose names match
80 one of the regular expressions in `special-display-regexps'.
81 This variable can be set in your init file, like this:
82 (setq special-display-frame-alist '((width . 80) (height . 20)))
83 These supersede the values given in `default-frame-alist'.")
85 ;; Display BUFFER in its own frame, reusing an existing window if any.
86 ;; Return the window chosen.
87 ;; Currently we do not insist on selecting the window within its frame.
88 ;; If ARGS is an alist, use it as a list of frame parameter specs.
89 ;; If ARGS is a list whose car is a symbol,
90 ;; use (car ARGS) as a function to do the work.
91 ;; Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args.
92 (defun special-display-popup-frame (buffer &optional args)
93 (if (and args (symbolp (car args)))
94 (apply (car args) buffer (cdr args))
95 (let ((window (get-buffer-window buffer t)))
96 (if window
97 ;; If we have a window already, make it visible.
98 (let ((frame (window-frame window)))
99 (make-frame-visible frame)
100 (raise-frame frame)
101 window)
102 ;; If no window yet, make one in a new frame.
103 (let ((frame (make-frame (append args special-display-frame-alist))))
104 (set-window-buffer (frame-selected-window frame) buffer)
105 (set-window-dedicated-p (frame-selected-window frame) t)
106 (frame-selected-window frame))))))
108 ;; Handle delete-frame events from the X server.
109 (defun handle-delete-frame (event)
110 (interactive "e")
111 (let ((frame (posn-window (event-start event)))
112 (i 0)
113 (tail (frame-list)))
114 (while tail
115 (and (frame-visible-p (car tail))
116 (not (eq (car tail) frame))
117 (setq i (1+ i)))
118 (setq tail (cdr tail)))
119 (if (> i 0)
120 (delete-frame frame t)
121 ;; Gildea@x.org says it is ok to ask questions before terminating.
122 (save-buffers-kill-emacs))))
124 ;;;; Arrangement of frames at startup
126 ;;; 1) Load the window system startup file from the lisp library and read the
127 ;;; high-priority arguments (-q and the like). The window system startup
128 ;;; file should create any frames specified in the window system defaults.
130 ;;; 2) If no frames have been opened, we open an initial text frame.
132 ;;; 3) Once the init file is done, we apply any newly set parameters
133 ;;; in initial-frame-alist to the frame.
135 ;; These are now called explicitly at the proper times,
136 ;; since that is easier to understand.
137 ;; Actually using hooks within Emacs is bad for future maintenance. --rms.
138 ;; (add-hook 'before-init-hook 'frame-initialize)
139 ;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
141 ;;; If we create the initial frame, this is it.
142 (defvar frame-initial-frame nil)
144 ;; Record the parameters used in frame-initialize to make the initial frame.
145 (defvar frame-initial-frame-alist)
147 (defvar frame-initial-geometry-arguments nil)
149 ;;; startup.el calls this function before loading the user's init
150 ;;; file - if there is no frame with a minibuffer open now, create
151 ;;; one to display messages while loading the init file.
152 (defun frame-initialize ()
154 ;; Are we actually running under a window system at all?
155 (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
156 (progn
157 ;; Turn on special-display processing only if there's a window system.
158 (setq special-display-function 'special-display-popup-frame)
160 ;; If there is no frame with a minibuffer besides the terminal
161 ;; frame, then we need to create the opening frame. Make sure
162 ;; it has a minibuffer, but let initial-frame-alist omit the
163 ;; minibuffer spec.
164 (or (delq terminal-frame (minibuffer-frame-list))
165 (progn
166 (setq frame-initial-frame-alist
167 (append initial-frame-alist default-frame-alist))
168 ;; Record these with their default values
169 ;; if they don't have any values explicitly.
170 (or (assq 'vertical-scroll-bars frame-initial-frame-alist)
171 (setq frame-initial-frame-alist
172 (cons '(vertical-scroll-bars . t)
173 frame-initial-frame-alist)))
174 (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
175 (setq frame-initial-frame-alist
176 (cons '(horizontal-scroll-bars . t)
177 frame-initial-frame-alist)))
178 (setq default-minibuffer-frame
179 (setq frame-initial-frame
180 (make-frame initial-frame-alist)))
181 ;; Delete any specifications for window geometry parameters
182 ;; so that we won't reapply them in frame-notice-user-settings.
183 ;; It would be wrong to reapply them then,
184 ;; because that would override explicit user resizing.
185 (setq initial-frame-alist
186 (frame-remove-geometry-params initial-frame-alist))))
187 ;; At this point, we know that we have a frame open, so we
188 ;; can delete the terminal frame.
189 (delete-frame terminal-frame)
190 (setq terminal-frame nil))
192 ;; No, we're not running a window system. Use make-terminal-frame if
193 ;; we support that feature, otherwise arrange to cause errors.
194 (or (eq window-system 'pc)
195 (setq frame-creation-function
196 (if (fboundp 'make-terminal-frame)
197 'make-terminal-frame
198 (function
199 (lambda (parameters)
200 (error
201 "Can't create multiple frames without a window system"))))))))
203 ;;; startup.el calls this function after loading the user's init
204 ;;; file. Now default-frame-alist and initial-frame-alist contain
205 ;;; information to which we must react; do what needs to be done.
206 (defun frame-notice-user-settings ()
208 ;; Make menu-bar-mode and default-frame-alist consistent.
209 (if (boundp 'menu-bar-mode)
210 (let ((default (assq 'menu-bar-lines default-frame-alist)))
211 (if default
212 (setq menu-bar-mode (not (eq (cdr default) 0)))
213 (setq default-frame-alist
214 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
215 default-frame-alist)))))
217 ;; Creating and deleting frames may shift the selected frame around,
218 ;; and thus the current buffer. Protect against that. We don't
219 ;; want to use save-excursion here, because that may also try to set
220 ;; the buffer of the selected window, which fails when the selected
221 ;; window is the minibuffer.
222 (let ((old-buffer (current-buffer)))
224 ;; If the initial frame is still around, apply initial-frame-alist
225 ;; and default-frame-alist to it.
226 (if (frame-live-p frame-initial-frame)
228 ;; The initial frame we create above always has a minibuffer.
229 ;; If the user wants to remove it, or make it a minibuffer-only
230 ;; frame, then we'll have to delete the current frame and make a
231 ;; new one; you can't remove or add a root window to/from an
232 ;; existing frame.
234 ;; NOTE: default-frame-alist was nil when we created the
235 ;; existing frame. We need to explicitly include
236 ;; default-frame-alist in the parameters of the screen we
237 ;; create here, so that its new value, gleaned from the user's
238 ;; .emacs file, will be applied to the existing screen.
239 (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
240 (assq 'minibuffer default-frame-alist)
241 '(minibuffer . t)))
243 ;; Create the new frame.
244 (let (parms new)
245 ;; If the frame isn't visible yet, wait till it is.
246 ;; If the user has to position the window,
247 ;; Emacs doesn't know its real position until
248 ;; the frame is seen to be visible.
249 (while (not (cdr (assq 'visibility
250 (frame-parameters frame-initial-frame))))
251 (sleep-for 1))
252 (setq parms (frame-parameters frame-initial-frame))
253 ;; Get rid of `name' unless it was specified explicitly before.
254 (or (assq 'name frame-initial-frame-alist)
255 (setq parms (delq (assq 'name parms) parms)))
256 (setq parms (append initial-frame-alist
257 default-frame-alist
258 parms
259 nil))
260 ;; Get rid of `reverse', because that was handled
261 ;; when we first made the frame.
262 (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
263 (if (assq 'height frame-initial-geometry-arguments)
264 (setq parms (frame-delete-all 'height parms)))
265 (if (assq 'width frame-initial-geometry-arguments)
266 (setq parms (frame-delete-all 'width parms)))
267 (if (assq 'left frame-initial-geometry-arguments)
268 (setq parms (frame-delete-all 'left parms)))
269 (if (assq 'top frame-initial-geometry-arguments)
270 (setq parms (frame-delete-all 'top parms)))
271 (setq new
272 (make-frame
273 ;; Use the geometry args that created the existing
274 ;; frame, rather than the parms we get for it.
275 (append frame-initial-geometry-arguments
276 '((user-size . t) (user-position . t))
277 parms)))
278 ;; The initial frame, which we are about to delete, may be
279 ;; the only frame with a minibuffer. If it is, create a
280 ;; new one.
281 (or (delq frame-initial-frame (minibuffer-frame-list))
282 (make-initial-minibuffer-frame nil))
284 ;; If the initial frame is serving as a surrogate
285 ;; minibuffer frame for any frames, we need to wean them
286 ;; onto a new frame. The default-minibuffer-frame
287 ;; variable must be handled similarly.
288 (let ((users-of-initial
289 (filtered-frame-list
290 (function (lambda (frame)
291 (and (not (eq frame frame-initial-frame))
292 (eq (window-frame
293 (minibuffer-window frame))
294 frame-initial-frame)))))))
295 (if (or users-of-initial
296 (eq default-minibuffer-frame frame-initial-frame))
298 ;; Choose an appropriate frame. Prefer frames which
299 ;; are only minibuffers.
300 (let* ((new-surrogate
301 (car
302 (or (filtered-frame-list
303 (function
304 (lambda (frame)
305 (eq (cdr (assq 'minibuffer
306 (frame-parameters frame)))
307 'only))))
308 (minibuffer-frame-list))))
309 (new-minibuffer (minibuffer-window new-surrogate)))
311 (if (eq default-minibuffer-frame frame-initial-frame)
312 (setq default-minibuffer-frame new-surrogate))
314 ;; Wean the frames using frame-initial-frame as
315 ;; their minibuffer frame.
316 (mapcar
317 (function
318 (lambda (frame)
319 (modify-frame-parameters
320 frame (list (cons 'minibuffer new-minibuffer)))))
321 users-of-initial))))
323 ;; Redirect events enqueued at this frame to the new frame.
324 ;; Is this a good idea?
325 (redirect-frame-focus frame-initial-frame new)
327 ;; Finally, get rid of the old frame.
328 (delete-frame frame-initial-frame t))
330 ;; Otherwise, we don't need all that rigamarole; just apply
331 ;; the new parameters.
332 (let (newparms allparms tail)
333 (setq allparms (append initial-frame-alist
334 default-frame-alist))
335 (if (assq 'height frame-initial-geometry-arguments)
336 (setq allparms (frame-delete-all 'height allparms)))
337 (if (assq 'width frame-initial-geometry-arguments)
338 (setq allparms (frame-delete-all 'width allparms)))
339 (if (assq 'left frame-initial-geometry-arguments)
340 (setq allparms (frame-delete-all 'left allparms)))
341 (if (assq 'top frame-initial-geometry-arguments)
342 (setq allparms (frame-delete-all 'top allparms)))
343 (setq tail allparms)
344 ;; Find just the parms that have changed since we first
345 ;; made this frame. Those are the ones actually set by
346 ;; the init file. For those parms whose values we already knew
347 ;; (such as those spec'd by command line options)
348 ;; it is undesirable to specify the parm again
349 ;; once the user has seen the frame and been able to alter it
350 ;; manually.
351 (while tail
352 (let (newval oldval)
353 (setq oldval (assq (car (car tail))
354 frame-initial-frame-alist))
355 (setq newval (cdr (assq (car (car tail)) allparms)))
356 (or (and oldval (eq (cdr oldval) newval))
357 (setq newparms
358 (cons (cons (car (car tail)) newval) newparms))))
359 (setq tail (cdr tail)))
360 (setq newparms (nreverse newparms))
361 (modify-frame-parameters frame-initial-frame
362 newparms)
363 (if (assq 'font newparms)
364 (frame-update-faces frame-initial-frame)))))
366 ;; Restore the original buffer.
367 (set-buffer old-buffer)
369 ;; Make sure the initial frame can be GC'd if it is ever deleted.
370 ;; Make sure frame-notice-user-settings does nothing if called twice.
371 (setq frame-initial-frame nil)))
373 (defun make-initial-minibuffer-frame (display)
374 (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
375 (if display
376 (make-frame-on-display display parms)
377 (make-frame parms))))
379 ;; Delete from ALIST all elements whose car is KEY.
380 ;; Return the modified alist.
381 (defun frame-delete-all (key alist)
382 (setq alist (copy-sequence alist))
383 (let ((tail alist))
384 (while tail
385 (if (eq (car (car tail)) key)
386 (setq alist (delq (car tail) alist)))
387 (setq tail (cdr tail)))
388 alist))
390 ;;;; Creation of additional frames, and other frame miscellanea
392 ;;; Return some frame other than the current frame, creating one if
393 ;;; necessary. Note that the minibuffer frame, if separate, is not
394 ;;; considered (see next-frame).
395 (defun get-other-frame ()
396 (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
397 (make-frame)
398 (next-frame (selected-frame)))))
401 (defun next-multiframe-window ()
402 "Select the next window, regardless of which frame it is on."
403 (interactive)
404 (select-window (next-window (selected-window)
405 (> (minibuffer-depth) 0)
406 t)))
408 (defun previous-multiframe-window ()
409 "Select the previous window, regardless of which frame it is on."
410 (interactive)
411 (select-window (previous-window (selected-window)
412 (> (minibuffer-depth) 0)
413 t)))
415 (defun make-frame-on-display (display &optional parameters)
416 "Make a frame on display DISPLAY.
417 The optional second argument PARAMETERS specifies additional frame parameters."
418 (interactive "sMake frame on display: ")
419 (make-frame (cons (cons 'display display) parameters)))
421 (defun make-frame-command ()
422 "Make a new frame, and select it if the terminal displays only one frame."
423 (interactive)
424 (if (and window-system (not (eq window-system 'pc)))
425 (make-frame)
426 (select-frame (make-frame))))
428 ;; Alias, kept temporarily.
429 (defalias 'new-frame 'make-frame)
430 (defun make-frame (&optional parameters)
431 "Create a new frame, displaying the current buffer.
433 Optional argument PARAMETERS is an alist of parameters for the new
434 frame. Specifically, PARAMETERS is a list of pairs, each having
435 the form (NAME . VALUE).
437 Here are some of the parameters allowed (not a complete list):
439 \(name . STRING) - The frame should be named STRING.
441 \(height . NUMBER) - The frame should be NUMBER text lines high. If
442 this parameter is present, the width parameter must also be
443 given.
445 \(width . NUMBER) - The frame should be NUMBER characters in width.
446 If this parameter is present, the height parameter must also
447 be given.
449 \(minibuffer . t) - the frame should have a minibuffer
450 \(minibuffer . nil) - the frame should have no minibuffer
451 \(minibuffer . only) - the frame should contain only a minibuffer
452 \(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window."
453 (interactive)
454 (let ((nframe))
455 (run-hooks 'before-make-frame-hook)
456 (setq nframe (funcall frame-creation-function parameters))
457 (run-hooks 'after-make-frame-hook)
458 nframe))
460 (defun filtered-frame-list (predicate)
461 "Return a list of all live frames which satisfy PREDICATE."
462 (let ((frames (frame-list))
463 good-frames)
464 (while (consp frames)
465 (if (funcall predicate (car frames))
466 (setq good-frames (cons (car frames) good-frames)))
467 (setq frames (cdr frames)))
468 good-frames))
470 (defun minibuffer-frame-list ()
471 "Return a list of all frames with their own minibuffers."
472 (filtered-frame-list
473 (function (lambda (frame)
474 (eq frame (window-frame (minibuffer-window frame)))))))
476 (defun frame-remove-geometry-params (param-list)
477 "Return the parameter list PARAM-LIST, but with geometry specs removed.
478 This deletes all bindings in PARAM-LIST for `top', `left', `width',
479 `height', `user-size' and `user-position' parameters.
480 Emacs uses this to avoid overriding explicit moves and resizings from
481 the user during startup."
482 (setq param-list (cons nil param-list))
483 (let ((tail param-list))
484 (while (consp (cdr tail))
485 (if (and (consp (car (cdr tail)))
486 (memq (car (car (cdr tail)))
487 '(height width top left user-position user-size)))
488 (progn
489 (setq frame-initial-geometry-arguments
490 (cons (car (cdr tail)) frame-initial-geometry-arguments))
491 (setcdr tail (cdr (cdr tail))))
492 (setq tail (cdr tail)))))
493 (setq frame-initial-geometry-arguments
494 (nreverse frame-initial-geometry-arguments))
495 (cdr param-list))
498 (defun other-frame (arg)
499 "Select the ARG'th different visible frame, and raise it.
500 All frames are arranged in a cyclic order.
501 This command selects the frame ARG steps away in that order.
502 A negative ARG moves in the opposite order."
503 (interactive "p")
504 (let ((frame (selected-frame)))
505 (while (> arg 0)
506 (setq frame (next-frame frame))
507 (while (not (eq (frame-visible-p frame) t))
508 (setq frame (next-frame frame)))
509 (setq arg (1- arg)))
510 (while (< arg 0)
511 (setq frame (previous-frame frame))
512 (while (not (eq (frame-visible-p frame) t))
513 (setq frame (previous-frame frame)))
514 (setq arg (1+ arg)))
515 (raise-frame frame)
516 (select-frame frame)
517 (set-mouse-position (selected-frame) (1- (frame-width)) 0)
518 (if (fboundp 'unfocus-frame)
519 (unfocus-frame))))
521 ;;;; Frame configurations
523 (defun current-frame-configuration ()
524 "Return a list describing the positions and states of all frames.
525 Its car is `frame-configuration'.
526 Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
527 where
528 FRAME is a frame object,
529 ALIST is an association list specifying some of FRAME's parameters, and
530 WINDOW-CONFIG is a window configuration object for FRAME."
531 (cons 'frame-configuration
532 (mapcar (function
533 (lambda (frame)
534 (list frame
535 (frame-parameters frame)
536 (current-window-configuration frame))))
537 (frame-list))))
539 (defun set-frame-configuration (configuration &optional nodelete)
540 "Restore the frames to the state described by CONFIGURATION.
541 Each frame listed in CONFIGURATION has its position, size, window
542 configuration, and other parameters set as specified in CONFIGURATION.
543 Ordinarily, this function deletes all existing frames not
544 listed in CONFIGURATION. But if optional second argument NODELETE
545 is given and non-nil, the unwanted frames are iconified instead."
546 (or (frame-configuration-p configuration)
547 (signal 'wrong-type-argument
548 (list 'frame-configuration-p configuration)))
549 (let ((config-alist (cdr configuration))
550 frames-to-delete)
551 (mapcar (function
552 (lambda (frame)
553 (let ((parameters (assq frame config-alist)))
554 (if parameters
555 (progn
556 (modify-frame-parameters
557 frame
558 ;; Since we can't set a frame's minibuffer status,
559 ;; we might as well omit the parameter altogether.
560 (let* ((parms (nth 1 parameters))
561 (mini (assq 'minibuffer parms)))
562 (if mini (setq parms (delq mini parms)))
563 parms))
564 (set-window-configuration (nth 2 parameters)))
565 (setq frames-to-delete (cons frame frames-to-delete))))))
566 (frame-list))
567 (if nodelete
568 ;; Note: making frames invisible here was tried
569 ;; but led to some strange behavior--each time the frame
570 ;; was made visible again, the window manager asked afresh
571 ;; for where to put it.
572 (mapcar 'iconify-frame frames-to-delete)
573 (mapcar 'delete-frame frames-to-delete))))
575 ;;;; Convenience functions for accessing and interactively changing
576 ;;;; frame parameters.
578 (defun frame-height (&optional frame)
579 "Return number of lines available for display on FRAME.
580 If FRAME is omitted, describe the currently selected frame."
581 (cdr (assq 'height (frame-parameters frame))))
583 (defun frame-width (&optional frame)
584 "Return number of columns available for display on FRAME.
585 If FRAME is omitted, describe the currently selected frame."
586 (cdr (assq 'width (frame-parameters frame))))
588 (defun set-default-font (font-name)
589 "Set the font of the selected frame to FONT.
590 When called interactively, prompt for the name of the font to use."
591 (interactive "sFont name: ")
592 (modify-frame-parameters (selected-frame)
593 (list (cons 'font font-name)))
594 ;; Update faces that want a bold or italic version of the default font.
595 (frame-update-faces (selected-frame)))
597 (defun set-background-color (color-name)
598 "Set the background color of the selected frame to COLOR.
599 When called interactively, prompt for the name of the color to use."
600 (interactive "sColor: ")
601 (modify-frame-parameters (selected-frame)
602 (list (cons 'background-color color-name)))
603 (frame-update-face-colors (selected-frame)))
605 (defun set-foreground-color (color-name)
606 "Set the foreground color of the selected frame to COLOR.
607 When called interactively, prompt for the name of the color to use."
608 (interactive "sColor: ")
609 (modify-frame-parameters (selected-frame)
610 (list (cons 'foreground-color color-name)))
611 (frame-update-face-colors (selected-frame)))
613 (defun set-cursor-color (color-name)
614 "Set the text cursor color of the selected frame to COLOR.
615 When called interactively, prompt for the name of the color to use."
616 (interactive "sColor: ")
617 (modify-frame-parameters (selected-frame)
618 (list (cons 'cursor-color color-name))))
620 (defun set-mouse-color (color-name)
621 "Set the color of the mouse pointer of the selected frame to COLOR.
622 When called interactively, prompt for the name of the color to use."
623 (interactive "sColor: ")
624 (modify-frame-parameters (selected-frame)
625 (list (cons 'mouse-color color-name))))
627 (defun set-border-color (color-name)
628 "Set the color of the border of the selected frame to COLOR.
629 When called interactively, prompt for the name of the color to use."
630 (interactive "sColor: ")
631 (modify-frame-parameters (selected-frame)
632 (list (cons 'border-color color-name))))
634 (defun auto-raise-mode (arg)
635 "Toggle whether or not the selected frame should auto-raise.
636 With arg, turn auto-raise mode on if and only if arg is positive.
637 Note that this controls Emacs's own auto-raise feature.
638 Some window managers allow you to enable auto-raise for certain windows.
639 You can use that for Emacs windows if you wish, but if you do,
640 that is beyond the control of Emacs and this command has no effect on it."
641 (interactive "P")
642 (if (null arg)
643 (setq arg
644 (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
645 -1 1)))
646 (modify-frame-parameters (selected-frame)
647 (list (cons 'auto-raise (> arg 0)))))
649 (defun auto-lower-mode (arg)
650 "Toggle whether or not the selected frame should auto-lower.
651 With arg, turn auto-lower mode on if and only if arg is positive.
652 Note that this controls Emacs's own auto-lower feature.
653 Some window managers allow you to enable auto-lower for certain windows.
654 You can use that for Emacs windows if you wish, but if you do,
655 that is beyond the control of Emacs and this command has no effect on it."
656 (interactive "P")
657 (if (null arg)
658 (setq arg
659 (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
660 -1 1)))
661 (modify-frame-parameters (selected-frame)
662 (list (cons 'auto-lower (> arg 0)))))
664 (defun toggle-scroll-bar (arg)
665 "Toggle whether or not the selected frame has vertical scroll bars.
666 With arg, turn vertical scroll bars on if and only if arg is positive."
667 (interactive "P")
668 (if (null arg)
669 (setq arg
670 (if (cdr (assq 'vertical-scroll-bars
671 (frame-parameters (selected-frame))))
672 -1 1)))
673 (modify-frame-parameters (selected-frame)
674 (list (cons 'vertical-scroll-bars (> arg 0)))))
676 (defun toggle-horizontal-scroll-bar (arg)
677 "Toggle whether or not the selected frame has horizontal scroll bars.
678 With arg, turn horizontal scroll bars on if and only if arg is positive.
679 Horizontal scroll bars aren't implemented yet."
680 (interactive "P")
681 (error "Horizontal scroll bars aren't implemented yet"))
684 ;;;; Aliases for backward compatibility with Emacs 18.
685 (defalias 'screen-height 'frame-height)
686 (defalias 'screen-width 'frame-width)
688 (defun set-screen-width (cols &optional pretend)
689 "Obsolete function to change the size of the screen to COLS columns.\n\
690 Optional second arg non-nil means that redisplay should use COLS columns\n\
691 but that the idea of the actual width of the frame should not be changed.\n\
692 This function is provided only for compatibility with Emacs 18; new code\n\
693 should use `set-frame-width instead'."
694 (set-frame-width (selected-frame) cols pretend))
696 (defun set-screen-height (lines &optional pretend)
697 "Obsolete function to change the height of the screen to LINES lines.\n\
698 Optional second arg non-nil means that redisplay should use LINES lines\n\
699 but that the idea of the actual height of the screen should not be changed.\n\
700 This function is provided only for compatibility with Emacs 18; new code\n\
701 should use `set-frame-width' instead."
702 (set-frame-height (selected-frame) lines pretend))
704 (make-obsolete 'screen-height 'frame-height)
705 (make-obsolete 'screen-width 'frame-width)
706 (make-obsolete 'set-screen-width 'set-frame-width)
707 (make-obsolete 'set-screen-height 'set-frame-height)
710 ;;;; Key bindings
711 (defvar ctl-x-5-map (make-sparse-keymap)
712 "Keymap for frame commands.")
713 (defalias 'ctl-x-5-prefix ctl-x-5-map)
714 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
716 (define-key ctl-x-5-map "2" 'make-frame-command)
717 (define-key ctl-x-5-map "0" 'delete-frame)
718 (define-key ctl-x-5-map "o" 'other-frame)
720 (provide 'frame)
722 ;;; frame.el ends here