frame.el 21 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
;;; frame.el --- multi-frame management independent of window systems.
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;;;; Copyright (C) 1993 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: internal
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;;; This file is part of GNU Emacs.
;;;
;;; GNU Emacs is free software; you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
12
;;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19 20 21 22 23
;;; any later version.
;;;
;;; GNU Emacs is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Emacs; see the file COPYING.  If not, write to
;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
24 25
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
26 27 28
(defvar frame-creation-function nil
  "Window-system dependent function to call to create a new frame.
The window system startup file should set this to its frame creation
Jim Blandy's avatar
Jim Blandy committed
29 30
function, which should take an alist of parameters as its argument.")

31 32 33
;;; The initial value given here for this must ask for a minibuffer.
;;; There must always exist a frame with a minibuffer, and after we
;;; delete the terminal frame, this will be the only frame.
Jim Blandy's avatar
Jim Blandy committed
34
(defvar initial-frame-alist '((minibuffer . t))
35 36
  "Alist of frame parameters for creating the initial X window frame.
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
37
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
38 39
If the value calls for a frame without a minibuffer, and you do not create a
minibuffer frame on your own, one is created according to
40
`minibuffer-frame-alist'.
41 42
Parameters specified here supersede the values given in
`default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
43

44
(defvar minibuffer-frame-alist '((width . 80) (height . 2))
45 46
  "Alist of frame parameters for initially creating a minibuffer frame.
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
47
 (setq minibuffer-frame-alist
48
   '((top . 1) (left . 1) (width . 80) (height . 2)))
49 50
Parameters specified here supersede the values given in
`default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
51

Jim Blandy's avatar
Jim Blandy committed
52
(defvar pop-up-frame-alist nil
53
  "Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
54
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
55
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
56
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
57
These supersede the values given in `default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
58

Jim Blandy's avatar
Jim Blandy committed
59
(setq pop-up-frame-function
Jim Blandy's avatar
Jim Blandy committed
60
      (function (lambda ()
Jim Blandy's avatar
Jim Blandy committed
61
		  (new-frame pop-up-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
62 63


Jim Blandy's avatar
Jim Blandy committed
64
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
65 66 67

;;; 1) Load the window system startup file from the lisp library and read the
;;; high-priority arguments (-q and the like).  The window system startup
Jim Blandy's avatar
Jim Blandy committed
68
;;; file should create any frames specified in the window system defaults.
Jim Blandy's avatar
Jim Blandy committed
69
;;; 
Jim Blandy's avatar
Jim Blandy committed
70
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
71 72
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
73
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
74

75 76 77 78 79
;; These are now called explicitly at the proper times, 
;; since that is easier to understand.
;; Actually using hooks within Emacs is bad for future maintenance. --rms.
;; (add-hook 'before-init-hook 'frame-initialize)
;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
Jim Blandy's avatar
Jim Blandy committed
80

Jim Blandy's avatar
Jim Blandy committed
81 82
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
83

84 85 86
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

Jim Blandy's avatar
Jim Blandy committed
87
;;; startup.el calls this function before loading the user's init
Jim Blandy's avatar
Jim Blandy committed
88
;;; file - if there is no frame with a minibuffer open now, create
Jim Blandy's avatar
Jim Blandy committed
89
;;; one to display messages while loading the init file.
Jim Blandy's avatar
Jim Blandy committed
90
(defun frame-initialize ()
Jim Blandy's avatar
Jim Blandy committed
91 92 93
  
  ;; Are we actually running under a window system at all?
  (if (and window-system (not noninteractive))
94 95 96 97 98 99
      (progn
	;; If there is no frame with a minibuffer besides the terminal
	;; frame, then we need to create the opening frame.  Make sure
	;; it has a minibuffer, but let initial-frame-alist omit the
	;; minibuffer spec.
	(or (delq terminal-frame (minibuffer-frame-list))
100
	    (progn
101 102
	      (setq frame-initial-frame-alist
		    (append initial-frame-alist default-frame-alist))
103 104 105
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
			  (new-frame initial-frame-alist)))
106 107 108 109
	      ;; Delete any specifications for window geometry parameters
	      ;; so that we won't reapply them in frame-notice-user-settings.
	      ;; It would be wrong to reapply them then,
	      ;; because that would override explicit user resizing.
110 111
	      (setq initial-frame-alist
		    (frame-remove-geometry-params initial-frame-alist))
112 113
	      ;; Handle `reverse' as a parameter.
	      (if (cdr (or (assq 'reverse initial-frame-alist)
114
			   (assq 'reverse default-frame-alist)))
115 116 117
		  (let ((params (frame-parameters frame-initial-frame)))
		    (modify-frame-parameters
		     frame-initial-frame
118 119
		     ;; Must set cursor-color after background color.
		     ;; So put it first.
Jim Blandy's avatar
Jim Blandy committed
120 121 122 123 124 125 126 127 128 129
		     (list (cons 'cursor-color
				 (cdr (assq 'background-color params)))
			   (cons 'foreground-color
				 (cdr (assq 'background-color params)))
			   (cons 'background-color
				 (cdr (assq 'foreground-color params)))
			   (cons 'mouse-color
				 (cdr (assq 'background-color params)))
			   (cons 'border-color
				 (cdr (assq 'background-color params)))))))))
130

Jim Blandy's avatar
Jim Blandy committed
131 132 133 134
	;; At this point, we know that we have a frame open, so we 
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Jim Blandy's avatar
Jim Blandy committed
135 136
    
    ;; No, we're not running a window system.  Arrange to cause errors.
Jim Blandy's avatar
Jim Blandy committed
137
    (setq frame-creation-function
138 139 140
	  (function
	   (lambda (parameters)
	     (error
141
	      "Can't create multiple frames without a window system"))))))
Jim Blandy's avatar
Jim Blandy committed
142
					
143 144 145
;;; startup.el calls this function after loading the user's init
;;; file.  Now default-frame-alist and initial-frame-alist contain
;;; information to which we must react; do what needs to be done.
Jim Blandy's avatar
Jim Blandy committed
146
(defun frame-notice-user-settings ()
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164

  ;; Creating and deleting frames may shift the selected frame around,
  ;; and thus the current buffer.  Protect against that.  We don't
  ;; want to use save-excursion here, because that may also try to set
  ;; the buffer of the selected window, which fails when the selected
  ;; window is the minibuffer.
  (let ((old-buffer (current-buffer)))

    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
    (if (frame-live-p frame-initial-frame)

	;; The initial frame we create above always has a minibuffer.
	;; If the user wants to remove it, or make it a minibuffer-only
	;; frame, then we'll have to delete the current frame and make a
	;; new one; you can't remove or add a root window to/from an
	;; existing frame.
	;;
Jim Blandy's avatar
Jim Blandy committed
165 166 167 168 169
	;; NOTE: default-frame-alist was nil when we created the
	;; existing frame.  We need to explicitly include
	;; default-frame-alist in the parameters of the screen we
	;; create here, so that its new value, gleaned from the user's
	;; .emacs file, will be applied to the existing screen.
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
	    (let ((new
		   (new-frame
		    (append initial-frame-alist
			    default-frame-alist
			    (frame-parameters frame-initial-frame)))))

	      ;; The initial frame, which we are about to delete, may be
	      ;; the only frame with a minibuffer.  If it is, create a
	      ;; new one.
	      (or (delq frame-initial-frame (minibuffer-frame-list))
		  (new-frame (append minibuffer-frame-alist
				     '((minibuffer . only)))))

	      ;; If the initial frame is serving as a surrogate
	      ;; minibuffer frame for any frames, we need to wean them
	      ;; onto a new frame.  The default-minibuffer-frame
	      ;; variable must be handled similarly.
	      (let ((users-of-initial
		     (filtered-frame-list
		      (function (lambda (frame)
				  (and (not (eq frame frame-initial-frame))
				       (eq (window-frame
					    (minibuffer-window frame))
					   frame-initial-frame)))))))
		(if (or users-of-initial
			(eq default-minibuffer-frame frame-initial-frame))

		    ;; Choose an appropriate frame.  Prefer frames which
		    ;; are only minibuffers.
		    (let* ((new-surrogate
			    (car
			     (or (filtered-frame-list
				  (function
				   (lambda (frame)
				     (eq (cdr (assq 'minibuffer
						    (frame-parameters frame)))
					 'only))))
				 (minibuffer-frame-list))))
			   (new-minibuffer (minibuffer-window new-surrogate)))

		      (if (eq default-minibuffer-frame frame-initial-frame)
			  (setq default-minibuffer-frame new-surrogate))

		      ;; Wean the frames using frame-initial-frame as
		      ;; their minibuffer frame.
		      (mapcar
		       (function
			(lambda (frame)
			  (modify-frame-parameters
			   frame (list (cons 'minibuffer new-minibuffer)))))
		       users-of-initial))))
Jim Blandy's avatar
Jim Blandy committed
226 227 228

	      ;; Redirect events enqueued at this frame to the new frame.
	      ;; Is this a good idea?
229
	      (redirect-frame-focus frame-initial-frame new)
Jim Blandy's avatar
Jim Blandy committed
230

231
	      ;; Finally, get rid of the old frame.
232
	      (delete-frame frame-initial-frame t))
233 234 235

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
	    (setq tail allparms)
	    ;; Find just the parms that have changed since we first
	    ;; made this frame.  Those are the ones actually set by
	    ;; the init file.  For those parms whose values we already knew
	    ;; (such as those spec'd by command line options)
	    ;; it is undesirable to specify the parm again
	    ;; once the user has seen the frame and been able to alter it
	    ;; manually.
	    (while tail
	      (let (newval oldval)
		(setq oldval (cdr (assq (car (car tail))
					frame-initial-frame-alist)))
		(setq newval (cdr (assq (car (car tail)) allparms)))
		(or (eq oldval newval)
		    (setq newparms
			  (cons (cons (car (car tail)) newval) newparms))))
	      (setq tail (cdr tail)))
	    (modify-frame-parameters frame-initial-frame
				     (nreverse newparms)))))
Jim Blandy's avatar
Jim Blandy committed
258

259 260 261 262
    ;; Restore the original buffer.
    (set-buffer old-buffer)

    ;; Make sure the initial frame can be GC'd if it is ever deleted.
263 264
    ;; Make sure frame-notice-user-settings does nothing if called twice.
    (setq frame-initial-frame nil)))
Jim Blandy's avatar
Jim Blandy committed
265 266


267
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
268

269
;;; Return some frame other than the current frame, creating one if
270
;;; necessary.  Note that the minibuffer frame, if separate, is not
271
;;; considered (see next-frame).
Jim Blandy's avatar
Jim Blandy committed
272
(defun get-other-frame ()
Jim Blandy's avatar
Jim Blandy committed
273 274 275
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
	       (new-frame)
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
276 277
    s))

Jim Blandy's avatar
Jim Blandy committed
278 279
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
280 281 282 283 284
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
			      t)))

Jim Blandy's avatar
Jim Blandy committed
285 286
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
287 288 289 290 291
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

292
;; Alias, kept temporarily.
293
(defalias 'new-frame 'make-frame)
294
(defun make-frame (&optional parameters)
Jim Blandy's avatar
Jim Blandy committed
295
  "Create a new frame, displaying the current buffer.
Jim Blandy's avatar
Jim Blandy committed
296

Jim Blandy's avatar
Jim Blandy committed
297
Optional argument PARAMETERS is an alist of parameters for the new
Jim Blandy's avatar
Jim Blandy committed
298
frame.  Specifically, PARAMETERS is a list of pairs, each having one
Jim Blandy's avatar
Jim Blandy committed
299 300
of the following forms:

301
\(name . STRING)	- The frame should be named STRING.
Jim Blandy's avatar
Jim Blandy committed
302

303
\(height . NUMBER) - The frame should be NUMBER text lines high.  If
Jim Blandy's avatar
Jim Blandy committed
304 305 306
	this parameter is present, the width parameter must also be
	given.

307
\(width . NUMBER) - The frame should be NUMBER characters in width.
Jim Blandy's avatar
Jim Blandy committed
308 309 310
	If this parameter is present, the height parameter must also
	be given.

311
\(minibuffer . t) - the frame should have a minibuffer
Jim Blandy's avatar
Jim Blandy committed
312
\(minibuffer . nil) - the frame should have no minibuffer
313 314
\(minibuffer . only) - the frame should contain only a minibuffer
\(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window.
Jim Blandy's avatar
Jim Blandy committed
315

316 317
The documentation for the function `x-create-frame' describes
additional frame parameters that Emacs recognizes for X window frames."
Jim Blandy's avatar
Jim Blandy committed
318
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
319
  (funcall frame-creation-function parameters))
Jim Blandy's avatar
Jim Blandy committed
320

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
  (let ((frames (frame-list))
	good-frames)
    (while (consp frames)
      (if (funcall predicate (car frames))
	  (setq good-frames (cons (car frames) good-frames)))
      (setq frames (cdr frames)))
    good-frames))

(defun minibuffer-frame-list ()
  "Return a list of all frames with their own minibuffers."
  (filtered-frame-list
   (function (lambda (frame)
	       (eq frame (window-frame (minibuffer-window frame)))))))

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
(defun frame-remove-geometry-params (param-list)
  "Return the parameter list PARAM-LIST, but with geometry specs removed.
This deletes all bindings in PARAM-LIST for `top', `left', `width',
and `height' parameters.
Emacs uses this to avoid overriding explicit moves and resizings from
the user during startup."
  (setq param-list (cons nil param-list))
  (let ((tail param-list))
    (while (consp (cdr tail))
      (if (and (consp (car (cdr tail)))
	       (memq (car (car (cdr tail))) '(height width top left)))
	  (setcdr tail (cdr (cdr tail)))
	(setq tail (cdr tail)))))
  (cdr param-list))


353
(defun other-frame (arg)
354
  "Select the ARG'th different visible frame, and raise it.
355 356 357 358 359 360
All frames are arranged in a cyclic order.
This command selects the frame ARG steps away in that order.
A negative ARG moves in the opposite order."
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
361 362 363 364
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
365
    (while (< arg 0)
366 367 368
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
369
      (setq arg (1+ arg)))
370 371
    (raise-frame frame)
    (select-frame frame)))
Jim Blandy's avatar
Jim Blandy committed
372

Jim Blandy's avatar
Jim Blandy committed
373 374 375 376
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
377 378 379 380 381 382 383 384 385 386 387 388 389
Its car is `frame-configuration'.
Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
where
  FRAME is a frame object,
  ALIST is an association list specifying some of FRAME's parameters, and
  WINDOW-CONFIG is a window configuration object for FRAME."
  (cons 'frame-configuration
	(mapcar (function
		 (lambda (frame)
		   (list frame
			 (frame-parameters frame)
			 (current-window-configuration frame))))
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393

(defun set-frame-configuration (configuration)
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
Jim Blandy's avatar
Jim Blandy committed
394
configuration, and other parameters set as specified in CONFIGURATION."
395 396 397 398 399
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
Jim Blandy's avatar
Jim Blandy committed
400
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
401
	     (lambda (frame)
402
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
403 404
		 (if parameters
		     (progn
405 406 407 408 409 410 411 412
		       (modify-frame-parameters
			frame
			;; Since we can't set a frame's minibuffer status, 
			;; we might as well omit the parameter altogether.
			(let* ((parms (nth 1 parameters))
			       (mini (assq 'minibuffer parms)))
			  (if mini (setq parms (delq mini parms)))
			  parms))
Jim Blandy's avatar
Jim Blandy committed
413
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
414 415 416
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
    (mapcar 'delete-frame frames-to-delete)))
Jim Blandy's avatar
Jim Blandy committed
417

418 419 420 421 422 423 424
(defun frame-configuration-p (object)
  "Return non-nil if OBJECT seems to be a frame configuration.
Any list whose car is `frame-configuration' is assumed to be a frame
configuration."
  (and (consp object)
       (eq (car object) 'frame-configuration)))

Jim Blandy's avatar
Jim Blandy committed
425

Jim Blandy's avatar
Jim Blandy committed
426 427
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
428

Jim Blandy's avatar
Jim Blandy committed
429
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
430 431
  "Return number of lines available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
Jim Blandy's avatar
Jim Blandy committed
432
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436

(defun frame-width (&optional frame)
  "Return number of columns available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
Jim Blandy's avatar
Jim Blandy committed
437
  (cdr (assq 'width (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
438

Jim Blandy's avatar
Jim Blandy committed
439
(defun set-default-font (font-name)
440 441
  "Set the font of the selected frame to FONT.
When called interactively, prompt for the name of the font to use."
Jim Blandy's avatar
Jim Blandy committed
442
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
443
  (modify-frame-parameters (selected-frame)
444
			   (list (cons 'font font-name))))
Jim Blandy's avatar
Jim Blandy committed
445

446
(defun set-background-color (color-name)
447 448
  "Set the background color of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
449
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
450
  (modify-frame-parameters (selected-frame)
451
			   (list (cons 'background-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
452

453
(defun set-foreground-color (color-name)
454 455
  "Set the foreground color of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
456
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
457
  (modify-frame-parameters (selected-frame)
458
			   (list (cons 'foreground-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
459 460

(defun set-cursor-color (color-name)
461 462
  "Set the text cursor color of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
463
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
464
  (modify-frame-parameters (selected-frame)
465
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
466

467
(defun set-mouse-color (color-name)
468 469
  "Set the color of the mouse pointer of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
470
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
471
  (modify-frame-parameters (selected-frame)
472 473
			   (list (cons 'mouse-color color-name))))

474 475 476 477 478 479 480 481
(defun set-border-color (color-name)
  "Set the color of the border of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
  (interactive "sColor: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
482 483 484 485 486 487 488
  "Toggle whether or not the selected frame should auto-raise.
With arg, turn auto-raise mode on if and only if arg is positive."
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
489
  (modify-frame-parameters (selected-frame)
490 491
			   (list (cons 'auto-raise (> arg 0)))))

492
(defun auto-lower-mode (arg)
493 494 495 496 497 498 499
  "Toggle whether or not the selected frame should auto-lower.
With arg, turn auto-lower mode on if and only if arg is positive."
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
500
  (modify-frame-parameters (selected-frame)
501 502
			   (list (cons 'auto-lower (> arg 0)))))

503
(defun toggle-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
504 505
  "Toggle whether or not the selected frame has vertical scroll bars.
With arg, turn vertical scroll bars on if and only if arg is positive."
506 507 508
  (interactive "P")
  (if (null arg)
      (setq arg
Jim Blandy's avatar
Jim Blandy committed
509
	    (if (cdr (assq 'vertical-scroll-bars
510 511
			   (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
512
  (modify-frame-parameters (selected-frame)
Jim Blandy's avatar
Jim Blandy committed
513
			   (list (cons 'vertical-scroll-bars (> arg 0)))))
514

515
(defun toggle-horizontal-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
516 517 518
  "Toggle whether or not the selected frame has horizontal scroll bars.
With arg, turn horizontal scroll bars on if and only if arg is positive.
Horizontal scroll bars aren't implemented yet."
519
  (interactive "P")
520
  (error "Horizontal scroll bars aren't implemented yet"))
Jim Blandy's avatar
Jim Blandy committed
521

Jim Blandy's avatar
Jim Blandy committed
522 523

;;;; Aliases for backward compatibility with Emacs 18.
524 525
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530 531

(defun set-screen-width (cols &optional pretend)
  "Obsolete function to change the size of the screen to COLS columns.\n\
Optional second arg non-nil means that redisplay should use COLS columns\n\
but that the idea of the actual width of the frame should not be changed.\n\
This function is provided only for compatibility with Emacs 18; new code\n\
Christopher Zaborsky's avatar
Christopher Zaborsky committed
532
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
533 534 535 536 537 538 539
  (set-frame-width (selected-frame) cols pretend))

(defun set-screen-height (lines &optional pretend)
  "Obsolete function to change the height of the screen to LINES lines.\n\
Optional second arg non-nil means that redisplay should use LINES lines\n\
but that the idea of the actual height of the screen should not be changed.\n\
This function is provided only for compatibility with Emacs 18; new code\n\
Christopher Zaborsky's avatar
Christopher Zaborsky committed
540
should use `set-frame-width' instead."
Jim Blandy's avatar
Jim Blandy committed
541 542 543 544 545 546
  (set-frame-height (selected-frame) lines pretend))

(make-obsolete 'screen-height 'frame-height)
(make-obsolete 'screen-width  'frame-width)
(make-obsolete 'set-screen-width 'set-frame-width)
(make-obsolete 'set-screen-height 'set-frame-height)
Jim Blandy's avatar
Jim Blandy committed
547

Jim Blandy's avatar
Jim Blandy committed
548 549

;;;; Key bindings
Jim Blandy's avatar
Jim Blandy committed
550
(defvar ctl-x-5-map (make-sparse-keymap)
Jim Blandy's avatar
Jim Blandy committed
551
  "Keymap for frame commands.")
552
(defalias 'ctl-x-5-prefix ctl-x-5-map)
Jim Blandy's avatar
Jim Blandy committed
553
(define-key ctl-x-map "5" 'ctl-x-5-prefix)
Jim Blandy's avatar
Jim Blandy committed
554

Jim Blandy's avatar
Jim Blandy committed
555 556
(define-key ctl-x-5-map "2" 'new-frame)
(define-key ctl-x-5-map "0" 'delete-frame)
557
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
558

Jim Blandy's avatar
Jim Blandy committed
559
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
560

Jim Blandy's avatar
Jim Blandy committed
561
;;; frame.el ends here