*** empty log message ***
[emacs.git] / lisp / frame.el
blob446bda557755aaffdbeb3f22e797b1eea2cae015
1 ;;; frame.el --- multi-frame management independent of window systems
3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2003, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;;; Code:
30 (defvar frame-creation-function nil
31 "Window-system dependent function to call to create a new frame.
32 The window system startup file should set this to its frame creation
33 function, which should take an alist of parameters as its argument.")
35 ;; The initial value given here used to ask for a minibuffer.
36 ;; But that's not necessary, because the default is to have one.
37 ;; By not specifying it here, we let an X resource specify it.
38 (defcustom initial-frame-alist nil
39 "*Alist of frame parameters for creating the initial X window frame.
40 You can set this in your `.emacs' file; for example,
41 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
42 Parameters specified here supersede the values given in `default-frame-alist'.
44 If the value calls for a frame without a minibuffer, and you have not created
45 a minibuffer frame on your own, one is created according to
46 `minibuffer-frame-alist'.
48 You can specify geometry-related options for just the initial frame
49 by setting this variable in your `.emacs' file; however, they won't
50 take effect until Emacs reads `.emacs', which happens after first creating
51 the frame. If you want the frame to have the proper geometry as soon
52 as it appears, you need to use this three-step process:
53 * Specify X resources to give the geometry you want.
54 * Set `default-frame-alist' to override these options so that they
55 don't affect subsequent frames.
56 * Set `initial-frame-alist' in a way that matches the X resources,
57 to override what you put in `default-frame-alist'."
58 :type '(repeat (cons :format "%v"
59 (symbol :tag "Parameter")
60 (sexp :tag "Value")))
61 :group 'frames)
63 (defcustom minibuffer-frame-alist '((width . 80) (height . 2))
64 "*Alist of frame parameters for initially creating a minibuffer frame.
65 You can set this in your `.emacs' file; for example,
66 (setq minibuffer-frame-alist
67 '((top . 1) (left . 1) (width . 80) (height . 2)))
68 Parameters specified here supersede the values given in
69 `default-frame-alist', for a minibuffer frame."
70 :type '(repeat (cons :format "%v"
71 (symbol :tag "Parameter")
72 (sexp :tag "Value")))
73 :group 'frames)
75 (defcustom pop-up-frame-alist nil
76 "*Alist of frame parameters used when creating pop-up frames.
77 Pop-up frames are used for completions, help, and the like.
78 This variable can be set in your init file, like this:
79 (setq pop-up-frame-alist '((width . 80) (height . 20)))
80 These supersede the values given in `default-frame-alist',
81 for pop-up frames."
82 :type '(repeat (cons :format "%v"
83 (symbol :tag "Parameter")
84 (sexp :tag "Value")))
85 :group 'frames)
87 (setq pop-up-frame-function
88 ;; Using `function' here caused some sort of problem.
89 '(lambda ()
90 (make-frame pop-up-frame-alist)))
92 (defcustom special-display-frame-alist
93 '((height . 14) (width . 80) (unsplittable . t))
94 "*Alist of frame parameters used when creating special frames.
95 Special frames are used for buffers whose names are in
96 `special-display-buffer-names' and for buffers whose names match
97 one of the regular expressions in `special-display-regexps'.
98 This variable can be set in your init file, like this:
99 (setq special-display-frame-alist '((width . 80) (height . 20)))
100 These supersede the values given in `default-frame-alist'."
101 :type '(repeat (cons :format "%v"
102 (symbol :tag "Parameter")
103 (sexp :tag "Value")))
104 :group 'frames)
106 (defun special-display-popup-frame (buffer &optional args)
107 "Display BUFFER in its own frame, reusing an existing window if any.
108 Return the window chosen.
109 Currently we do not insist on selecting the window within its frame.
110 If ARGS is an alist, use it as a list of frame parameter specs.
111 If ARGS is a list whose car is a symbol,
112 use (car ARGS) as a function to do the work.
113 Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args."
114 (if (and args (symbolp (car args)))
115 (apply (car args) buffer (cdr args))
116 (let ((window (get-buffer-window buffer 0)))
118 ;; If we have a window already, make it visible.
119 (when window
120 (let ((frame (window-frame window)))
121 (make-frame-visible frame)
122 (raise-frame frame)
123 window))
124 ;; Reuse the current window if the user requested it.
125 (when (cdr (assq 'same-window args))
126 (condition-case nil
127 (progn (switch-to-buffer buffer) (selected-window))
128 (error nil)))
129 ;; Stay on the same frame if requested.
130 (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
131 (let* ((pop-up-frames nil) (pop-up-windows t)
132 special-display-regexps special-display-buffer-names
133 (window (display-buffer buffer)))
134 ;; Only do it if this is a new window:
135 ;; (set-window-dedicated-p window t)
136 window))
137 ;; If no window yet, make one in a new frame.
138 (let ((frame (make-frame (append args special-display-frame-alist))))
139 (set-window-buffer (frame-selected-window frame) buffer)
140 (set-window-dedicated-p (frame-selected-window frame) t)
141 (frame-selected-window frame))))))
143 (defun handle-delete-frame (event)
144 "Handle delete-frame events from the X server."
145 (interactive "e")
146 (let ((frame (posn-window (event-start event)))
147 (i 0)
148 (tail (frame-list)))
149 (while tail
150 (and (frame-visible-p (car tail))
151 (not (eq (car tail) frame))
152 (setq i (1+ i)))
153 (setq tail (cdr tail)))
154 (if (> i 0)
155 (delete-frame frame t)
156 ;; Gildea@x.org says it is ok to ask questions before terminating.
157 (save-buffers-kill-emacs))))
159 ;;;; Arrangement of frames at startup
161 ;; 1) Load the window system startup file from the lisp library and read the
162 ;; high-priority arguments (-q and the like). The window system startup
163 ;; file should create any frames specified in the window system defaults.
165 ;; 2) If no frames have been opened, we open an initial text frame.
167 ;; 3) Once the init file is done, we apply any newly set parameters
168 ;; in initial-frame-alist to the frame.
170 ;; These are now called explicitly at the proper times,
171 ;; since that is easier to understand.
172 ;; Actually using hooks within Emacs is bad for future maintenance. --rms.
173 ;; (add-hook 'before-init-hook 'frame-initialize)
174 ;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
176 ;; If we create the initial frame, this is it.
177 (defvar frame-initial-frame nil)
179 ;; Record the parameters used in frame-initialize to make the initial frame.
180 (defvar frame-initial-frame-alist)
182 (defvar frame-initial-geometry-arguments nil)
184 ;; startup.el calls this function before loading the user's init
185 ;; file - if there is no frame with a minibuffer open now, create
186 ;; one to display messages while loading the init file.
187 (defun frame-initialize ()
188 "Create an initial frame if necessary."
189 ;; Are we actually running under a window system at all?
190 (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
191 (progn
192 ;; Turn on special-display processing only if there's a window system.
193 (setq special-display-function 'special-display-popup-frame)
195 ;; If there is no frame with a minibuffer besides the terminal
196 ;; frame, then we need to create the opening frame. Make sure
197 ;; it has a minibuffer, but let initial-frame-alist omit the
198 ;; minibuffer spec.
199 (or (delq terminal-frame (minibuffer-frame-list))
200 (progn
201 (setq frame-initial-frame-alist
202 (append initial-frame-alist default-frame-alist nil))
203 (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
204 (setq frame-initial-frame-alist
205 (cons '(horizontal-scroll-bars . t)
206 frame-initial-frame-alist)))
207 (setq default-minibuffer-frame
208 (setq frame-initial-frame
209 (make-frame frame-initial-frame-alist)))
210 ;; Delete any specifications for window geometry parameters
211 ;; so that we won't reapply them in frame-notice-user-settings.
212 ;; It would be wrong to reapply them then,
213 ;; because that would override explicit user resizing.
214 (setq initial-frame-alist
215 (frame-remove-geometry-params initial-frame-alist))))
216 ;; At this point, we know that we have a frame open, so we
217 ;; can delete the terminal frame.
218 (delete-frame terminal-frame)
219 (setq terminal-frame nil))
221 ;; No, we're not running a window system. Use make-terminal-frame if
222 ;; we support that feature, otherwise arrange to cause errors.
223 (or (eq window-system 'pc)
224 (setq frame-creation-function
225 (if (fboundp 'tty-create-frame-with-faces)
226 'tty-create-frame-with-faces
227 (function
228 (lambda (parameters)
229 (error
230 "Can't create multiple frames without a window system"))))))))
232 (defvar frame-notice-user-settings t
233 "Non-nil means function `frame-notice-user-settings' wasn't run yet.")
235 ;; startup.el calls this function after loading the user's init
236 ;; file. Now default-frame-alist and initial-frame-alist contain
237 ;; information to which we must react; do what needs to be done.
238 (defun frame-notice-user-settings ()
239 "Act on user's init file settings of frame parameters.
240 React to settings of `default-frame-alist', `initial-frame-alist' there."
241 ;; Make menu-bar-mode and default-frame-alist consistent.
242 (when (boundp 'menu-bar-mode)
243 (let ((default (assq 'menu-bar-lines default-frame-alist)))
244 (if default
245 (setq menu-bar-mode (not (eq (cdr default) 0)))
246 (setq default-frame-alist
247 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
248 default-frame-alist)))))
250 ;; Make tool-bar-mode and default-frame-alist consistent. Don't do
251 ;; it in batch mode since that would leave a tool-bar-lines
252 ;; parameter in default-frame-alist in a dumped Emacs, which is not
253 ;; what we want.
254 (when (and (boundp 'tool-bar-mode)
255 (not noninteractive))
256 (let ((default (assq 'tool-bar-lines default-frame-alist)))
257 (if default
258 (setq tool-bar-mode (not (eq (cdr default) 0)))
259 (setq default-frame-alist
260 (cons (cons 'tool-bar-lines (if tool-bar-mode 1 0))
261 default-frame-alist)))))
263 ;; Creating and deleting frames may shift the selected frame around,
264 ;; and thus the current buffer. Protect against that. We don't
265 ;; want to use save-excursion here, because that may also try to set
266 ;; the buffer of the selected window, which fails when the selected
267 ;; window is the minibuffer.
268 (let ((old-buffer (current-buffer)))
270 (when (and frame-notice-user-settings
271 (null frame-initial-frame))
272 ;; This case happens when we don't have a window system, and
273 ;; also for MS-DOS frames.
274 (let ((parms (frame-parameters frame-initial-frame)))
275 ;; Don't change the frame names.
276 (setq parms (delq (assq 'name parms) parms))
277 ;; Can't modify the minibuffer parameter, so don't try.
278 (setq parms (delq (assq 'minibuffer parms) parms))
279 (modify-frame-parameters nil
280 (if (null window-system)
281 (append initial-frame-alist
282 default-frame-alist
283 parms
284 nil)
285 ;; initial-frame-alist and
286 ;; default-frame-alist were already
287 ;; applied in pc-win.el.
288 parms))
289 (if (null window-system) ;; MS-DOS does this differently in pc-win.el
290 (let ((newparms (frame-parameters))
291 (frame (selected-frame)))
292 (tty-handle-reverse-video frame newparms)
293 ;; If we changed the background color, we need to update
294 ;; the background-mode parameter, and maybe some faces,
295 ;; too.
296 (when (assq 'background-color newparms)
297 (unless (or (assq 'background-mode initial-frame-alist)
298 (assq 'background-mode default-frame-alist))
299 (frame-set-background-mode frame))
300 (face-set-after-frame-default frame))))))
302 ;; If the initial frame is still around, apply initial-frame-alist
303 ;; and default-frame-alist to it.
304 (when (frame-live-p frame-initial-frame)
306 ;; When tool-bar has been switched off, correct the frame size
307 ;; by the lines added in x-create-frame for the tool-bar and
308 ;; switch `tool-bar-mode' off.
309 (when (display-graphic-p)
310 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
311 (assq 'tool-bar-lines default-frame-alist))))
312 (when (and tool-bar-originally-present
313 (or (null tool-bar-lines)
314 (null (cdr tool-bar-lines))
315 (eq 0 (cdr tool-bar-lines))))
316 (let* ((char-height (frame-char-height frame-initial-frame))
317 (image-height tool-bar-images-pixel-height)
318 (margin (cond ((and (consp tool-bar-button-margin)
319 (integerp (cdr tool-bar-button-margin))
320 (> tool-bar-button-margin 0))
321 (cdr tool-bar-button-margin))
322 ((and (integerp tool-bar-button-margin)
323 (> tool-bar-button-margin 0))
324 tool-bar-button-margin)
325 (t 0)))
326 (relief (if (and (integerp tool-bar-button-relief)
327 (> tool-bar-button-relief 0))
328 tool-bar-button-relief 3))
329 (lines (/ (+ image-height
330 (* 2 margin)
331 (* 2 relief)
332 (1- char-height))
333 char-height))
334 (height (frame-parameter frame-initial-frame 'height))
335 (newparms (list (cons 'height (- height lines))))
336 (initial-top (cdr (assq 'top
337 frame-initial-geometry-arguments)))
338 (top (frame-parameter frame-initial-frame 'top)))
339 (when (and (consp initial-top) (eq '- (car initial-top)))
340 (let ((adjusted-top
341 (cond ((and (consp top)
342 (eq '+ (car top)))
343 (list '+
344 (+ (cadr top)
345 (* lines char-height))))
346 ((and (consp top)
347 (eq '- (car top)))
348 (list '-
349 (- (cadr top)
350 (* lines char-height))))
351 (t (+ top (* lines char-height))))))
352 (setq newparms
353 (append newparms
354 `((top . ,adjusted-top))
355 nil))))
356 (modify-frame-parameters frame-initial-frame newparms)
357 (tool-bar-mode -1)))))
359 ;; The initial frame we create above always has a minibuffer.
360 ;; If the user wants to remove it, or make it a minibuffer-only
361 ;; frame, then we'll have to delete the current frame and make a
362 ;; new one; you can't remove or add a root window to/from an
363 ;; existing frame.
365 ;; NOTE: default-frame-alist was nil when we created the
366 ;; existing frame. We need to explicitly include
367 ;; default-frame-alist in the parameters of the screen we
368 ;; create here, so that its new value, gleaned from the user's
369 ;; .emacs file, will be applied to the existing screen.
370 (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
371 (assq 'minibuffer default-frame-alist)
372 '(minibuffer . t)))
374 ;; Create the new frame.
375 (let (parms new)
376 ;; If the frame isn't visible yet, wait till it is.
377 ;; If the user has to position the window,
378 ;; Emacs doesn't know its real position until
379 ;; the frame is seen to be visible.
380 (while (not (cdr (assq 'visibility
381 (frame-parameters frame-initial-frame))))
382 (sleep-for 1))
383 (setq parms (frame-parameters frame-initial-frame))
385 ;; Get rid of `name' unless it was specified explicitly before.
386 (or (assq 'name frame-initial-frame-alist)
387 (setq parms (delq (assq 'name parms) parms)))
389 (setq parms (append initial-frame-alist
390 default-frame-alist
391 parms
392 nil))
394 ;; Get rid of `reverse', because that was handled
395 ;; when we first made the frame.
396 (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
398 (if (assq 'height frame-initial-geometry-arguments)
399 (setq parms (assq-delete-all 'height parms)))
400 (if (assq 'width frame-initial-geometry-arguments)
401 (setq parms (assq-delete-all 'width parms)))
402 (if (assq 'left frame-initial-geometry-arguments)
403 (setq parms (assq-delete-all 'left parms)))
404 (if (assq 'top frame-initial-geometry-arguments)
405 (setq parms (assq-delete-all 'top parms)))
406 (setq new
407 (make-frame
408 ;; Use the geometry args that created the existing
409 ;; frame, rather than the parms we get for it.
410 (append frame-initial-geometry-arguments
411 '((user-size . t) (user-position . t))
412 parms)))
413 ;; The initial frame, which we are about to delete, may be
414 ;; the only frame with a minibuffer. If it is, create a
415 ;; new one.
416 (or (delq frame-initial-frame (minibuffer-frame-list))
417 (make-initial-minibuffer-frame nil))
419 ;; If the initial frame is serving as a surrogate
420 ;; minibuffer frame for any frames, we need to wean them
421 ;; onto a new frame. The default-minibuffer-frame
422 ;; variable must be handled similarly.
423 (let ((users-of-initial
424 (filtered-frame-list
425 (function (lambda (frame)
426 (and (not (eq frame frame-initial-frame))
427 (eq (window-frame
428 (minibuffer-window frame))
429 frame-initial-frame)))))))
430 (if (or users-of-initial
431 (eq default-minibuffer-frame frame-initial-frame))
433 ;; Choose an appropriate frame. Prefer frames which
434 ;; are only minibuffers.
435 (let* ((new-surrogate
436 (car
437 (or (filtered-frame-list
438 (function
439 (lambda (frame)
440 (eq (cdr (assq 'minibuffer
441 (frame-parameters frame)))
442 'only))))
443 (minibuffer-frame-list))))
444 (new-minibuffer (minibuffer-window new-surrogate)))
446 (if (eq default-minibuffer-frame frame-initial-frame)
447 (setq default-minibuffer-frame new-surrogate))
449 ;; Wean the frames using frame-initial-frame as
450 ;; their minibuffer frame.
451 (mapcar
452 (function
453 (lambda (frame)
454 (modify-frame-parameters
455 frame (list (cons 'minibuffer new-minibuffer)))))
456 users-of-initial))))
458 ;; Redirect events enqueued at this frame to the new frame.
459 ;; Is this a good idea?
460 (redirect-frame-focus frame-initial-frame new)
462 ;; Finally, get rid of the old frame.
463 (delete-frame frame-initial-frame t))
465 ;; Otherwise, we don't need all that rigamarole; just apply
466 ;; the new parameters.
467 (let (newparms allparms tail)
468 (setq allparms (append initial-frame-alist
469 default-frame-alist nil))
470 (if (assq 'height frame-initial-geometry-arguments)
471 (setq allparms (assq-delete-all 'height allparms)))
472 (if (assq 'width frame-initial-geometry-arguments)
473 (setq allparms (assq-delete-all 'width allparms)))
474 (if (assq 'left frame-initial-geometry-arguments)
475 (setq allparms (assq-delete-all 'left allparms)))
476 (if (assq 'top frame-initial-geometry-arguments)
477 (setq allparms (assq-delete-all 'top allparms)))
478 (setq tail allparms)
479 ;; Find just the parms that have changed since we first
480 ;; made this frame. Those are the ones actually set by
481 ;; the init file. For those parms whose values we already knew
482 ;; (such as those spec'd by command line options)
483 ;; it is undesirable to specify the parm again
484 ;; once the user has seen the frame and been able to alter it
485 ;; manually.
486 (while tail
487 (let (newval oldval)
488 (setq oldval (assq (car (car tail))
489 frame-initial-frame-alist))
490 (setq newval (cdr (assq (car (car tail)) allparms)))
491 (or (and oldval (eq (cdr oldval) newval))
492 (setq newparms
493 (cons (cons (car (car tail)) newval) newparms))))
494 (setq tail (cdr tail)))
495 (setq newparms (nreverse newparms))
496 (modify-frame-parameters frame-initial-frame
497 newparms)
498 ;; If we changed the background color,
499 ;; we need to update the background-mode parameter
500 ;; and maybe some faces too.
501 (when (assq 'background-color newparms)
502 (unless (assq 'background-mode newparms)
503 (frame-set-background-mode frame-initial-frame))
504 (face-set-after-frame-default frame-initial-frame)))))
506 ;; Restore the original buffer.
507 (set-buffer old-buffer)
509 ;; Make sure the initial frame can be GC'd if it is ever deleted.
510 ;; Make sure frame-notice-user-settings does nothing if called twice.
511 (setq frame-notice-user-settings nil)
512 (setq frame-initial-frame nil)))
514 (defun make-initial-minibuffer-frame (display)
515 (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
516 (if display
517 (make-frame-on-display display parms)
518 (make-frame parms))))
520 ;;;; Creation of additional frames, and other frame miscellanea
522 (defun modify-all-frames-parameters (alist)
523 "modify all current and future frames parameters according to ALIST.
524 This changes `default-frame-alist' and possibly `initial-frame-alist'.
525 See help of `modify-frame-parameters' for more information."
526 (let (element) ;; temp
527 (dolist (frame (frame-list))
528 (modify-frame-parameters frame alist))
530 (dolist (pair alist) ;; conses to add/replace
531 ;; initial-frame-alist needs setting only when
532 ;; frame-notice-user-settings is true
533 (and frame-notice-user-settings
534 (setq element (assoc (car pair) initial-frame-alist))
535 (setq initial-frame-alist (delq element initial-frame-alist)))
536 (and (setq element (assoc (car pair) default-frame-alist))
537 (setq default-frame-alist (delq element default-frame-alist)))))
538 (and frame-notice-user-settings
539 (setq initial-frame-alist (append initial-frame-alist alist)))
540 (setq default-frame-alist (append default-frame-alist alist)))
542 (defun get-other-frame ()
543 "Return some frame other than the current frame.
544 Create one if necessary. Note that the minibuffer frame, if separate,
545 is not considered (see `next-frame')."
546 (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
547 (make-frame)
548 (next-frame (selected-frame)))))
551 (defun next-multiframe-window ()
552 "Select the next window, regardless of which frame it is on."
553 (interactive)
554 (select-window (next-window (selected-window)
555 (> (minibuffer-depth) 0)
557 (select-frame-set-input-focus (selected-frame)))
559 (defun previous-multiframe-window ()
560 "Select the previous window, regardless of which frame it is on."
561 (interactive)
562 (select-window (previous-window (selected-window)
563 (> (minibuffer-depth) 0)
565 (select-frame-set-input-focus (selected-frame)))
567 (defun make-frame-on-display (display &optional parameters)
568 "Make a frame on display DISPLAY.
569 The optional second argument PARAMETERS specifies additional frame parameters."
570 (interactive "sMake frame on display: ")
571 (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
572 (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
573 (make-frame (cons (cons 'display display) parameters)))
575 (defun make-frame-command ()
576 "Make a new frame, and select it if the terminal displays only one frame."
577 (interactive)
578 (if (and window-system (not (eq window-system 'pc)))
579 (make-frame)
580 (select-frame (make-frame))))
582 (defvar before-make-frame-hook nil
583 "Functions to run before a frame is created.")
585 (defvar after-make-frame-functions nil
586 "Functions to run after a frame is created.
587 The functions are run with one arg, the newly created frame.")
589 (defvar after-setting-font-hook nil
590 "Functions to run after a frame's font has been changed.")
592 ;; Alias, kept temporarily.
593 (defalias 'new-frame 'make-frame)
594 (make-obsolete 'new-frame 'make-frame "21.4")
596 (defun make-frame (&optional parameters)
597 "Return a newly created frame displaying the current buffer.
598 Optional argument PARAMETERS is an alist of parameters for the new frame.
599 Each element of PARAMETERS should have the form (NAME . VALUE), for example:
601 (name . STRING) The frame should be named STRING.
603 (width . NUMBER) The frame should be NUMBER characters in width.
604 (height . NUMBER) The frame should be NUMBER text lines high.
606 You cannot specify either `width' or `height', you must use neither or both.
608 (minibuffer . t) The frame should have a minibuffer.
609 (minibuffer . nil) The frame should have no minibuffer.
610 (minibuffer . only) The frame should contain only a minibuffer.
611 (minibuffer . WINDOW) The frame should use WINDOW as its minibuffer window.
613 Before the frame is created (via `frame-creation-function'), functions on the
614 hook `before-make-frame-hook' are run. After the frame is created, functions
615 on `after-make-frame-functions' are run with one arg, the newly created frame."
616 (interactive)
617 (run-hooks 'before-make-frame-hook)
618 (let ((frame (funcall frame-creation-function parameters)))
619 (run-hook-with-args 'after-make-frame-functions frame)
620 frame))
622 (defun filtered-frame-list (predicate)
623 "Return a list of all live frames which satisfy PREDICATE."
624 (let* ((frames (frame-list))
625 (list frames))
626 (while (consp frames)
627 (unless (funcall predicate (car frames))
628 (setcar frames nil))
629 (setq frames (cdr frames)))
630 (delq nil list)))
632 (defun minibuffer-frame-list ()
633 "Return a list of all frames with their own minibuffers."
634 (filtered-frame-list
635 (function (lambda (frame)
636 (eq frame (window-frame (minibuffer-window frame)))))))
638 (defun frames-on-display-list (&optional display)
639 "Return a list of all frames on DISPLAY.
640 DISPLAY is a name of a display, a string of the form HOST:SERVER.SCREEN.
641 If DISPLAY is omitted or nil, it defaults to the selected frame's display."
642 (let* ((display (or display (frame-parameter nil 'display)))
643 (func #'(lambda (frame)
644 (equal (frame-parameter frame 'display) display))))
645 (filtered-frame-list func)))
647 (defun framep-on-display (&optional display)
648 "Return the type of frames on DISPLAY.
649 DISPLAY may be a display name or a frame. If it is a frame, its type is
650 returned.
651 If DISPLAY is omitted or nil, it defaults to the selected frame's display.
652 All frames on a given display are of the same type."
653 (or (framep display)
654 (framep (car (frames-on-display-list display)))))
656 (defun frame-remove-geometry-params (param-list)
657 "Return the parameter list PARAM-LIST, but with geometry specs removed.
658 This deletes all bindings in PARAM-LIST for `top', `left', `width',
659 `height', `user-size' and `user-position' parameters.
660 Emacs uses this to avoid overriding explicit moves and resizings from
661 the user during startup."
662 (setq param-list (cons nil param-list))
663 (let ((tail param-list))
664 (while (consp (cdr tail))
665 (if (and (consp (car (cdr tail)))
666 (memq (car (car (cdr tail)))
667 '(height width top left user-position user-size)))
668 (progn
669 (setq frame-initial-geometry-arguments
670 (cons (car (cdr tail)) frame-initial-geometry-arguments))
671 (setcdr tail (cdr (cdr tail))))
672 (setq tail (cdr tail)))))
673 (setq frame-initial-geometry-arguments
674 (nreverse frame-initial-geometry-arguments))
675 (cdr param-list))
677 (defcustom focus-follows-mouse t
678 "*Non-nil if window system changes focus when you move the mouse.
679 You should set this variable to tell Emacs how your window manager
680 handles focus, since there is no way in general for Emacs to find out
681 automatically."
682 :type 'boolean
683 :group 'frames
684 :version "20.3")
686 (defun select-frame-set-input-focus (frame)
687 "Select FRAME, raise it, and set input focus, if possible."
688 (select-frame frame)
689 (raise-frame frame)
690 ;; Ensure, if possible, that frame gets input focus.
691 (cond ((eq window-system 'x)
692 (x-focus-frame frame))
693 ((eq window-system 'w32)
694 (w32-focus-frame frame)))
695 (cond (focus-follows-mouse
696 (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
698 (defun other-frame (arg)
699 "Select the ARG'th different visible frame on current display, and raise it.
700 All frames are arranged in a cyclic order.
701 This command selects the frame ARG steps away in that order.
702 A negative ARG moves in the opposite order.
704 To make this command work properly, you must tell Emacs
705 how the system (or the window manager) generally handles
706 focus-switching between windows. If moving the mouse onto a window
707 selects it (gives it focus), set `focus-follows-mouse' to t.
708 Otherwise, that variable should be nil."
709 (interactive "p")
710 (let ((frame (selected-frame)))
711 (while (> arg 0)
712 (setq frame (next-frame frame))
713 (while (not (eq (frame-visible-p frame) t))
714 (setq frame (next-frame frame)))
715 (setq arg (1- arg)))
716 (while (< arg 0)
717 (setq frame (previous-frame frame))
718 (while (not (eq (frame-visible-p frame) t))
719 (setq frame (previous-frame frame)))
720 (setq arg (1+ arg)))
721 (select-frame-set-input-focus frame)))
723 (defun iconify-or-deiconify-frame ()
724 "Iconify the selected frame, or deiconify if it's currently an icon."
725 (interactive)
726 (if (eq (cdr (assq 'visibility (frame-parameters))) t)
727 (iconify-frame)
728 (make-frame-visible)))
730 (defun make-frame-names-alist ()
731 (let* ((current-frame (selected-frame))
732 (falist
733 (cons
734 (cons (frame-parameter current-frame 'name) current-frame) nil))
735 (frame (next-frame nil t)))
736 (while (not (eq frame current-frame))
737 (progn
738 (setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
739 (setq frame (next-frame frame t))))
740 falist))
742 (defvar frame-name-history nil)
743 (defun select-frame-by-name (name)
744 "Select the frame on the current terminal whose name is NAME and raise it.
745 If there is no frame by that name, signal an error."
746 (interactive
747 (let* ((frame-names-alist (make-frame-names-alist))
748 (default (car (car frame-names-alist)))
749 (input (completing-read
750 (format "Select Frame (default %s): " default)
751 frame-names-alist nil t nil 'frame-name-history)))
752 (if (= (length input) 0)
753 (list default)
754 (list input))))
755 (let* ((frame-names-alist (make-frame-names-alist))
756 (frame (cdr (assoc name frame-names-alist))))
757 (or frame
758 (error "There is no frame named `%s'" name))
759 (make-frame-visible frame)
760 (raise-frame frame)
761 (select-frame frame)
762 ;; Ensure, if possible, that frame gets input focus.
763 (cond ((eq window-system 'x)
764 (x-focus-frame frame))
765 ((eq window-system 'w32)
766 (w32-focus-frame frame)))
767 (when focus-follows-mouse
768 (set-mouse-position frame (1- (frame-width frame)) 0))))
770 ;;;; Frame configurations
772 (defun current-frame-configuration ()
773 "Return a list describing the positions and states of all frames.
774 Its car is `frame-configuration'.
775 Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
776 where
777 FRAME is a frame object,
778 ALIST is an association list specifying some of FRAME's parameters, and
779 WINDOW-CONFIG is a window configuration object for FRAME."
780 (cons 'frame-configuration
781 (mapcar (function
782 (lambda (frame)
783 (list frame
784 (frame-parameters frame)
785 (current-window-configuration frame))))
786 (frame-list))))
788 (defun set-frame-configuration (configuration &optional nodelete)
789 "Restore the frames to the state described by CONFIGURATION.
790 Each frame listed in CONFIGURATION has its position, size, window
791 configuration, and other parameters set as specified in CONFIGURATION.
792 Ordinarily, this function deletes all existing frames not
793 listed in CONFIGURATION. But if optional second argument NODELETE
794 is given and non-nil, the unwanted frames are iconified instead."
795 (or (frame-configuration-p configuration)
796 (signal 'wrong-type-argument
797 (list 'frame-configuration-p configuration)))
798 (let ((config-alist (cdr configuration))
799 frames-to-delete)
800 (mapcar (function
801 (lambda (frame)
802 (let ((parameters (assq frame config-alist)))
803 (if parameters
804 (progn
805 (modify-frame-parameters
806 frame
807 ;; Since we can't set a frame's minibuffer status,
808 ;; we might as well omit the parameter altogether.
809 (let* ((parms (nth 1 parameters))
810 (mini (assq 'minibuffer parms)))
811 (if mini (setq parms (delq mini parms)))
812 parms))
813 (set-window-configuration (nth 2 parameters)))
814 (setq frames-to-delete (cons frame frames-to-delete))))))
815 (frame-list))
816 (if nodelete
817 ;; Note: making frames invisible here was tried
818 ;; but led to some strange behavior--each time the frame
819 ;; was made visible again, the window manager asked afresh
820 ;; for where to put it.
821 (mapcar 'iconify-frame frames-to-delete)
822 (mapcar 'delete-frame frames-to-delete))))
824 ;;;; Convenience functions for accessing and interactively changing
825 ;;;; frame parameters.
827 (defun frame-height (&optional frame)
828 "Return number of lines available for display on FRAME.
829 If FRAME is omitted, describe the currently selected frame."
830 (cdr (assq 'height (frame-parameters frame))))
832 (defun frame-width (&optional frame)
833 "Return number of columns available for display on FRAME.
834 If FRAME is omitted, describe the currently selected frame."
835 (cdr (assq 'width (frame-parameters frame))))
837 (defalias 'set-default-font 'set-frame-font)
838 (defun set-frame-font (font-name &optional keep-size)
839 "Set the font of the selected frame to FONT-NAME.
840 When called interactively, prompt for the name of the font to use.
841 To get the frame's current default font, use `frame-parameters'.
843 The default behavior is to keep the numbers of lines and columns in
844 the frame, thus may change its pixel size. If optional KEEP-SIZE is
845 non-nil (interactively, prefix argument) the current frame size (in
846 pixels) is kept by adjusting the numbers of the lines and columns."
847 (interactive
848 (let* ((completion-ignore-case t)
849 (font (completing-read "Font name: "
850 (mapcar #'list
851 ;; x-list-fonts will fail with an error
852 ;; if this frame doesn't support fonts.
853 (x-list-fonts "*" nil (selected-frame)))
854 nil nil nil nil
855 (frame-parameter nil 'font))))
856 (list font current-prefix-arg)))
857 (let (fht fwd)
858 (if keep-size
859 (setq fht (* (frame-parameter nil 'height) (frame-char-height))
860 fwd (* (frame-parameter nil 'width) (frame-char-width))))
861 (modify-frame-parameters (selected-frame)
862 (list (cons 'font font-name)))
863 (if keep-size
864 (modify-frame-parameters
865 (selected-frame)
866 (list (cons 'height (round fht (frame-char-height)))
867 (cons 'width (round fwd (frame-char-width)))))))
868 (run-hooks 'after-setting-font-hook 'after-setting-font-hooks))
870 (defun set-frame-parameter (frame parameter value)
871 (modify-frame-parameters frame (list (cons parameter value))))
873 (defun set-background-color (color-name)
874 "Set the background color of the selected frame to COLOR-NAME.
875 When called interactively, prompt for the name of the color to use.
876 To get the frame's current background color, use `frame-parameters'."
877 (interactive (list (facemenu-read-color)))
878 (modify-frame-parameters (selected-frame)
879 (list (cons 'background-color color-name)))
880 (or window-system
881 (face-set-after-frame-default (selected-frame))))
883 (defun set-foreground-color (color-name)
884 "Set the foreground color of the selected frame to COLOR-NAME.
885 When called interactively, prompt for the name of the color to use.
886 To get the frame's current foreground color, use `frame-parameters'."
887 (interactive (list (facemenu-read-color)))
888 (modify-frame-parameters (selected-frame)
889 (list (cons 'foreground-color color-name)))
890 (or window-system
891 (face-set-after-frame-default (selected-frame))))
893 (defun set-cursor-color (color-name)
894 "Set the text cursor color of the selected frame to COLOR-NAME.
895 When called interactively, prompt for the name of the color to use.
896 To get the frame's current cursor color, use `frame-parameters'."
897 (interactive (list (facemenu-read-color)))
898 (modify-frame-parameters (selected-frame)
899 (list (cons 'cursor-color color-name))))
901 (defun set-mouse-color (color-name)
902 "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
903 When called interactively, prompt for the name of the color to use.
904 To get the frame's current mouse color, use `frame-parameters'."
905 (interactive (list (facemenu-read-color)))
906 (modify-frame-parameters (selected-frame)
907 (list (cons 'mouse-color
908 (or color-name
909 (cdr (assq 'mouse-color
910 (frame-parameters))))))))
912 (defun set-border-color (color-name)
913 "Set the color of the border of the selected frame to COLOR-NAME.
914 When called interactively, prompt for the name of the color to use.
915 To get the frame's current border color, use `frame-parameters'."
916 (interactive (list (facemenu-read-color)))
917 (modify-frame-parameters (selected-frame)
918 (list (cons 'border-color color-name))))
920 (defun auto-raise-mode (arg)
921 "Toggle whether or not the selected frame should auto-raise.
922 With arg, turn auto-raise mode on if and only if arg is positive.
923 Note that this controls Emacs's own auto-raise feature.
924 Some window managers allow you to enable auto-raise for certain windows.
925 You can use that for Emacs windows if you wish, but if you do,
926 that is beyond the control of Emacs and this command has no effect on it."
927 (interactive "P")
928 (if (null arg)
929 (setq arg
930 (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
931 -1 1)))
932 (if (> arg 0)
933 (raise-frame (selected-frame)))
934 (modify-frame-parameters (selected-frame)
935 (list (cons 'auto-raise (> arg 0)))))
937 (defun auto-lower-mode (arg)
938 "Toggle whether or not the selected frame should auto-lower.
939 With arg, turn auto-lower mode on if and only if arg is positive.
940 Note that this controls Emacs's own auto-lower feature.
941 Some window managers allow you to enable auto-lower for certain windows.
942 You can use that for Emacs windows if you wish, but if you do,
943 that is beyond the control of Emacs and this command has no effect on it."
944 (interactive "P")
945 (if (null arg)
946 (setq arg
947 (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
948 -1 1)))
949 (modify-frame-parameters (selected-frame)
950 (list (cons 'auto-lower (> arg 0)))))
951 (defun set-frame-name (name)
952 "Set the name of the selected frame to NAME.
953 When called interactively, prompt for the name of the frame.
954 The frame name is displayed on the modeline if the terminal displays only
955 one frame, otherwise the name is displayed on the frame's caption bar."
956 (interactive "sFrame name: ")
957 (modify-frame-parameters (selected-frame)
958 (list (cons 'name name))))
960 (defun frame-current-scroll-bars (&optional frame)
961 "Return the current scroll-bar settings in frame FRAME.
962 Value is a cons (VERTICAL . HORISONTAL) where VERTICAL specifies the
963 current location of the vertical scroll-bars (left, right, or nil),
964 and HORISONTAL specifies the current location of the horisontal scroll
965 bars (top, bottom, or nil)."
966 (let ((vert (frame-parameter frame 'vertical-scroll-bars))
967 (hor nil))
968 (unless (memq vert '(left right nil))
969 (setq vert default-frame-scroll-bars))
970 (cons vert hor)))
972 ;;;; Frame/display capabilities.
973 (defun display-mouse-p (&optional display)
974 "Return non-nil if DISPLAY has a mouse available.
975 DISPLAY can be a display name, a frame, or nil (meaning the selected
976 frame's display)."
977 (let ((frame-type (framep-on-display display)))
978 (cond
979 ((eq frame-type 'pc)
980 (msdos-mouse-p))
981 ((eq system-type 'windows-nt)
982 (> w32-num-mouse-buttons 0))
983 ((memq frame-type '(x mac))
984 t) ;; We assume X and Mac *always* have a pointing device
986 (or (and (featurep 'xt-mouse)
987 xterm-mouse-mode)
988 ;; t-mouse is distributed with the GPM package. It doesn't have
989 ;; a toggle.
990 (featurep 't-mouse))))))
992 (defun display-popup-menus-p (&optional display)
993 "Return non-nil if popup menus are supported on DISPLAY.
994 DISPLAY can be a display name, a frame, or nil (meaning the selected
995 frame's display).
996 Support for popup menus requires that the mouse be available."
997 (and
998 (let ((frame-type (framep-on-display display)))
999 (memq frame-type '(x w32 pc mac)))
1000 (display-mouse-p display)))
1002 (defun display-graphic-p (&optional display)
1003 "Return non-nil if DISPLAY is a graphic display.
1004 Graphical displays are those which are capable of displaying several
1005 frames and several different fonts at once. This is true for displays
1006 that use a window system such as X, and false for text-only terminals.
1007 DISPLAY can be a display name, a frame, or nil (meaning the selected
1008 frame's display)."
1009 (not (null (memq (framep-on-display display) '(x w32 mac)))))
1011 (defun display-images-p (&optional display)
1012 "Return non-nil if DISPLAY can display images.
1014 DISPLAY can be a display name, a frame, or nil (meaning the selected
1015 frame's display)."
1016 (and (display-graphic-p display)
1017 (fboundp 'image-mask-p)
1018 (fboundp 'image-size)))
1020 (defalias 'display-multi-frame-p 'display-graphic-p)
1021 (defalias 'display-multi-font-p 'display-graphic-p)
1023 (defun display-selections-p (&optional display)
1024 "Return non-nil if DISPLAY supports selections.
1025 A selection is a way to transfer text or other data between programs
1026 via special system buffers called `selection' or `cut buffer' or
1027 `clipboard'.
1028 DISPLAY can be a display name, a frame, or nil (meaning the selected
1029 frame's display)."
1030 (let ((frame-type (framep-on-display display)))
1031 (cond
1032 ((eq frame-type 'pc)
1033 ;; MS-DOG frames support selections when Emacs runs inside
1034 ;; the Windows' DOS Box.
1035 (not (null dos-windows-version)))
1036 ((memq frame-type '(x w32 mac))
1037 t) ;; FIXME?
1039 nil))))
1041 (defun display-screens (&optional display)
1042 "Return the number of screens associated with DISPLAY."
1043 (let ((frame-type (framep-on-display display)))
1044 (cond
1045 ((memq frame-type '(x w32))
1046 (x-display-screens display))
1047 (t ;; FIXME: is this correct for the Mac?
1048 1))))
1050 (defun display-pixel-height (&optional display)
1051 "Return the height of DISPLAY's screen in pixels.
1052 For character terminals, each character counts as a single pixel."
1053 (let ((frame-type (framep-on-display display)))
1054 (cond
1055 ((memq frame-type '(x w32 mac))
1056 (x-display-pixel-height display))
1058 (frame-height (if (framep display) display (selected-frame)))))))
1060 (defun display-pixel-width (&optional display)
1061 "Return the width of DISPLAY's screen in pixels.
1062 For character terminals, each character counts as a single pixel."
1063 (let ((frame-type (framep-on-display display)))
1064 (cond
1065 ((memq frame-type '(x w32 mac))
1066 (x-display-pixel-width display))
1068 (frame-width (if (framep display) display (selected-frame)))))))
1070 (defun display-mm-height (&optional display)
1071 "Return the height of DISPLAY's screen in millimeters.
1072 If the information is unavailable, value is nil."
1073 (and (memq (framep-on-display display) '(x w32 mac))
1074 (x-display-mm-height display)))
1076 (defun display-mm-width (&optional display)
1077 "Return the width of DISPLAY's screen in millimeters.
1078 If the information is unavailable, value is nil."
1079 (and (memq (framep-on-display display) '(x w32 mac))
1080 (x-display-mm-width display)))
1082 (defun display-backing-store (&optional display)
1083 "Return the backing store capability of DISPLAY's screen.
1084 The value may be `always', `when-mapped', `not-useful', or nil if
1085 the question is inapplicable to a certain kind of display."
1086 (let ((frame-type (framep-on-display display)))
1087 (cond
1088 ((memq frame-type '(x w32 mac))
1089 (x-display-backing-store display))
1091 'not-useful))))
1093 (defun display-save-under (&optional display)
1094 "Return non-nil if DISPLAY's screen supports the SaveUnder feature."
1095 (let ((frame-type (framep-on-display display)))
1096 (cond
1097 ((memq frame-type '(x w32 mac))
1098 (x-display-save-under display))
1100 'not-useful))))
1102 (defun display-planes (&optional display)
1103 "Return the number of planes supported by DISPLAY."
1104 (let ((frame-type (framep-on-display display)))
1105 (cond
1106 ((memq frame-type '(x w32 mac))
1107 (x-display-planes display))
1108 ((eq frame-type 'pc)
1111 (truncate (log (length (tty-color-alist)) 2))))))
1113 (defun display-color-cells (&optional display)
1114 "Return the number of color cells supported by DISPLAY."
1115 (let ((frame-type (framep-on-display display)))
1116 (cond
1117 ((memq frame-type '(x w32 mac))
1118 (x-display-color-cells display))
1119 ((eq frame-type 'pc)
1122 (tty-display-color-cells)))))
1124 (defun display-visual-class (&optional display)
1125 "Returns the visual class of DISPLAY.
1126 The value is one of the symbols `static-gray', `gray-scale',
1127 `static-color', `pseudo-color', `true-color', or `direct-color'."
1128 (let ((frame-type (framep-on-display display)))
1129 (cond
1130 ((memq frame-type '(x w32 mac))
1131 (x-display-visual-class display))
1132 ((and (memq frame-type '(pc t))
1133 (tty-display-color-p display))
1134 'static-color)
1136 'static-gray))))
1139 ;;;; Aliases for backward compatibility with Emacs 18.
1140 (defalias 'screen-height 'frame-height)
1141 (defalias 'screen-width 'frame-width)
1143 (defun set-screen-width (cols &optional pretend)
1144 "Obsolete function to change the size of the screen to COLS columns.
1145 Optional second arg non-nil means that redisplay should use COLS columns
1146 but that the idea of the actual width of the frame should not be changed.
1147 This function is provided only for compatibility with Emacs 18; new code
1148 should use `set-frame-width instead'."
1149 (set-frame-width (selected-frame) cols pretend))
1151 (defun set-screen-height (lines &optional pretend)
1152 "Obsolete function to change the height of the screen to LINES lines.
1153 Optional second arg non-nil means that redisplay should use LINES lines
1154 but that the idea of the actual height of the screen should not be changed.
1155 This function is provided only for compatibility with Emacs 18; new code
1156 should use `set-frame-height' instead."
1157 (set-frame-height (selected-frame) lines pretend))
1159 (defun delete-other-frames (&optional frame)
1160 "Delete all frames except FRAME.
1161 If FRAME uses another frame's minibuffer, the minibuffer frame is
1162 left untouched. FRAME nil or omitted means use the selected frame."
1163 (interactive)
1164 (unless frame
1165 (setq frame (selected-frame)))
1166 (let* ((mini-frame (window-frame (minibuffer-window frame)))
1167 (frames (delq mini-frame (delq frame (frame-list)))))
1168 ;; Delete mon-minibuffer-only frames first, because `delete-frame'
1169 ;; signals an error when trying to delete a mini-frame that's
1170 ;; still in use by another frame.
1171 (dolist (frame frames)
1172 (unless (eq (frame-parameter frame 'minibuffer) 'only)
1173 (delete-frame frame)))
1174 ;; Delete minibuffer-only frames.
1175 (dolist (frame frames)
1176 (when (eq (frame-parameter frame 'minibuffer) 'only)
1177 (delete-frame frame)))))
1179 (make-obsolete 'screen-height 'frame-height) ;before 19.15
1180 (make-obsolete 'screen-width 'frame-width) ;before 19.15
1181 (make-obsolete 'set-screen-width 'set-frame-width) ;before 19.15
1182 (make-obsolete 'set-screen-height 'set-frame-height) ;before 19.15
1184 ;; miscellaneous obsolescence declarations
1185 (defvaralias 'delete-frame-hook 'delete-frame-functions)
1186 (make-obsolete-variable 'delete-frame-hook 'delete-frame-functions "21.4")
1189 ;; Highlighting trailing whitespace.
1191 (make-variable-buffer-local 'show-trailing-whitespace)
1193 (defcustom show-trailing-whitespace nil
1194 "*Non-nil means highlight trailing whitespace.
1195 This is done in the face `trailing-whitespace'."
1196 :tag "Highlight trailing whitespace."
1197 :type 'boolean
1198 :group 'font-lock)
1202 ;; Scrolling
1204 (defgroup scrolling nil
1205 "Scrolling windows."
1206 :version "21.1"
1207 :group 'frames)
1209 (defcustom auto-hscroll-mode t
1210 "*Allow or disallow automatic scrolling windows horizontally.
1211 If non-nil, windows are automatically scrolled horizontally to make
1212 point visible."
1213 :version "21.1"
1214 :type 'boolean
1215 :group 'scrolling)
1216 (defvaralias 'automatic-hscrolling 'auto-hscroll-mode)
1219 ;; Blinking cursor
1221 (defgroup cursor nil
1222 "Displaying text cursors."
1223 :version "21.1"
1224 :group 'frames)
1226 (defcustom blink-cursor-delay 0.5
1227 "*Seconds of idle time after which cursor starts to blink."
1228 :tag "Delay in seconds."
1229 :type 'number
1230 :group 'cursor)
1232 (defcustom blink-cursor-interval 0.5
1233 "*Length of cursor blink interval in seconds."
1234 :tag "Blink interval in seconds."
1235 :type 'number
1236 :group 'cursor)
1238 (defvar blink-cursor-idle-timer nil
1239 "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
1240 The function `blink-cursor-start' is called when the timer fires.")
1242 (defvar blink-cursor-timer nil
1243 "Timer started from `blink-cursor-start'.
1244 This timer calls `blink-cursor' every `blink-cursor-interval' seconds.")
1246 (defvar blink-cursor-mode nil
1247 "Non-nil means blinking cursor is active.")
1249 (defun blink-cursor-mode (arg)
1250 "Toggle blinking cursor mode.
1251 With a numeric argument, turn blinking cursor mode on iff ARG is positive.
1252 When blinking cursor mode is enabled, the cursor of the selected
1253 window blinks.
1255 Note that this command is effective only when Emacs
1256 displays through a window system, because then Emacs does its own
1257 cursor display. On a text-only terminal, this is not implemented."
1258 (interactive "P")
1259 (let ((on-p (if (null arg)
1260 (not blink-cursor-mode)
1261 (> (prefix-numeric-value arg) 0))))
1262 (if blink-cursor-idle-timer
1263 (cancel-timer blink-cursor-idle-timer))
1264 (if blink-cursor-timer
1265 (cancel-timer blink-cursor-timer))
1266 (setq blink-cursor-idle-timer nil
1267 blink-cursor-timer nil
1268 blink-cursor-mode nil)
1269 (if on-p
1270 (progn
1271 ;; Hide the cursor.
1272 ;(internal-show-cursor nil nil)
1273 (setq blink-cursor-idle-timer
1274 (run-with-idle-timer blink-cursor-delay
1275 blink-cursor-delay
1276 'blink-cursor-start))
1277 (setq blink-cursor-mode t))
1278 (internal-show-cursor nil t))))
1280 ;; Note that this is really initialized from startup.el before
1281 ;; the init-file is read.
1283 (defcustom blink-cursor nil
1284 "*Non-nil means blinking cursor mode is active."
1285 :group 'cursor
1286 :tag "Blinking cursor"
1287 :type 'boolean
1288 :set #'(lambda (symbol value)
1289 (set-default symbol value)
1290 (blink-cursor-mode (or value 0))))
1292 (defun blink-cursor-start ()
1293 "Timer function called from the timer `blink-cursor-idle-timer'.
1294 This starts the timer `blink-cursor-timer', which makes the cursor blink
1295 if appropriate. It also arranges to cancel that timer when the next
1296 command starts, by installing a pre-command hook."
1297 (when (null blink-cursor-timer)
1298 (add-hook 'pre-command-hook 'blink-cursor-end)
1299 (internal-show-cursor nil nil)
1300 (setq blink-cursor-timer
1301 (run-with-timer blink-cursor-interval blink-cursor-interval
1302 'blink-cursor-timer-function))))
1304 (defun blink-cursor-timer-function ()
1305 "Timer function of timer `blink-cursor-timer'."
1306 (internal-show-cursor nil (not (internal-show-cursor-p))))
1308 (defun blink-cursor-end ()
1309 "Stop cursor blinking.
1310 This is installed as a pre-command hook by `blink-cursor-start'.
1311 When run, it cancels the timer `blink-cursor-timer' and removes
1312 itself as a pre-command hook."
1313 (remove-hook 'pre-command-hook 'blink-cursor-end)
1314 (internal-show-cursor nil t)
1315 (cancel-timer blink-cursor-timer)
1316 (setq blink-cursor-timer nil))
1320 ;; Hourglass pointer
1322 (defcustom display-hourglass t
1323 "*Non-nil means show an hourglass pointer when running under a window system."
1324 :tag "Hourglass pointer"
1325 :type 'boolean
1326 :group 'cursor)
1328 (defcustom hourglass-delay 1
1329 "*Seconds to wait before displaying an hourglass pointer."
1330 :tag "Hourglass delay"
1331 :type 'number
1332 :group 'cursor)
1335 (defcustom cursor-in-non-selected-windows t
1336 "*Non-nil means show a hollow box cursor in non-selected-windows.
1337 If nil, don't show a cursor except in the selected window.
1338 Use Custom to set this variable to get the display updated."
1339 :tag "Cursor in non-selected windows"
1340 :type 'boolean
1341 :group 'cursor
1342 :set #'(lambda (symbol value)
1343 (set-default symbol value)
1344 (force-mode-line-update t)))
1347 ;;;; Key bindings
1349 (define-key ctl-x-5-map "2" 'make-frame-command)
1350 (define-key ctl-x-5-map "1" 'delete-other-frames)
1351 (define-key ctl-x-5-map "0" 'delete-frame)
1352 (define-key ctl-x-5-map "o" 'other-frame)
1354 (provide 'frame)
1356 ;;; arch-tag: 82979c70-b8f2-4306-b2ad-ddbd6b328b56
1357 ;;; frame.el ends here